Struct re_types_blueprint::blueprint::archetypes::ContainerBlueprint

pub struct ContainerBlueprint {
    pub container_kind: ContainerKind,
    pub display_name: Option<Name>,
    pub contents: Option<Vec<IncludedContent>>,
    pub col_shares: Option<Vec<ColumnShare>>,
    pub row_shares: Option<Vec<RowShare>>,
    pub active_tab: Option<ActiveTab>,
    pub visible: Option<Visible>,
    pub grid_columns: Option<GridColumns>,
}

Archetype: The top-level description of the Viewport.

Fields

container_kind: ContainerKind

The class of the view.

display_name: Option<Name>

The name of the container.

contents: Option<Vec<IncludedContent>>

ContainerIdss or SpaceViewIds that are children of this container.

col_shares: Option<Vec<ColumnShare>>

The layout shares of each column in the container.

For Horizontal containers, the length of this list should always match the number of contents.

Ignored for Vertical containers.

row_shares: Option<Vec<RowShare>>

The layout shares of each row of the container.

For Vertical containers, the length of this list should always match the number of contents.

Ignored for Horizontal containers.

active_tab: Option<ActiveTab>

Which tab is active.

Only applies to Tabs containers.

visible: Option<Visible>

Whether this container is visible.

Defaults to true if not specified.

grid_columns: Option<GridColumns>

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for Horizontal/Vertical containers.

Implementations

impl ContainerBlueprint

pub const NUM_COMPONENTS: usize = 9usize

The total number of components in the archetype: 1 required, 1 recommended, 7 optional

impl ContainerBlueprint

pub fn new(container_kind: impl Into<ContainerKind>) -> Self

Create a new ContainerBlueprint.

pub fn with_display_name(self, display_name: impl Into<Name>) -> Self

The name of the container.

pub fn with_contents( self, contents: impl IntoIterator<Item = impl Into<IncludedContent>> ) -> Self

ContainerIdss or SpaceViewIds that are children of this container.

pub fn with_col_shares( self, col_shares: impl IntoIterator<Item = impl Into<ColumnShare>> ) -> Self

The layout shares of each column in the container.

For Horizontal containers, the length of this list should always match the number of contents.

Ignored for Vertical containers.

pub fn with_row_shares( self, row_shares: impl IntoIterator<Item = impl Into<RowShare>> ) -> Self

The layout shares of each row of the container.

For Vertical containers, the length of this list should always match the number of contents.

Ignored for Horizontal containers.

pub fn with_active_tab(self, active_tab: impl Into<ActiveTab>) -> Self

Which tab is active.

Only applies to Tabs containers.

pub fn with_visible(self, visible: impl Into<Visible>) -> Self

Whether this container is visible.

Defaults to true if not specified.

pub fn with_grid_columns(self, grid_columns: impl Into<GridColumns>) -> Self

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for Horizontal/Vertical containers.

Trait Implementations

impl Archetype for ContainerBlueprint

type Indicator = GenericIndicatorComponent<ContainerBlueprint>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn indicator() -> MaybeOwnedComponentBatch<'static>

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for ContainerBlueprint

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs.

fn to_arrow(&self) -> Result<Vec<(Field, Box<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for ContainerBlueprint

fn clone(&self) -> ContainerBlueprint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContainerBlueprint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SizeBytes for ContainerBlueprint

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.