Struct FrameView 

pub struct FrameView<'a> {
    pub simbox: Option<&'a SimBox>,
    pub meta: &'a HashMap<String, String>,
    /* private fields */
}

A borrowed, read-only view of a Frame.

Block keys are &str references into the original Frame’s key strings. Block values are BlockViews that borrow the underlying column data. simbox and meta are borrowed by reference.

Fields

simbox: Option<&'a SimBox>

Borrowed simulation box, if present.

meta: &'a HashMap<String, String>

Borrowed metadata map.

Implementations

impl<'a> FrameView<'a>

pub fn from_parts( map: HashMap<&'a str, BlockView<'a>>, simbox: Option<&'a SimBox>, meta: &'a HashMap<String, String>, ) -> FrameView<'a>

Construct a FrameView from parts.

pub fn get(&self, key: &str) -> Option<&BlockView<'a>>

Gets an immutable reference to the block view for key if present.

pub fn iter(&self) -> impl Iterator<Item = (&&'a str, &BlockView<'a>)>

Returns an iterator over (&str, &BlockView).

pub fn keys(&self) -> impl Iterator<Item = &&'a str>

Returns an iterator over block keys.

pub fn values(&self) -> impl Iterator<Item = &BlockView<'a>>

Returns an iterator over block view references.

pub fn len(&self) -> usize

Number of blocks in the view.

pub fn is_empty(&self) -> bool

Returns true if the view contains no blocks.

pub fn contains_key(&self, key: &str) -> bool

Returns true if the view contains the specified block key.

pub fn to_owned(&self) -> Frame

Creates an owned Frame by cloning all viewed data.

Trait Implementations

impl Debug for FrameView<'_>

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

Formats the value using the given formatter.

impl FrameAccess for FrameView<'_>

fn get_float( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&f64>, Dim<IxDynImpl>>>

Gets a float array view from a column inside a block.

fn get_int( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&i32>, Dim<IxDynImpl>>>

Gets an int array view from a column inside a block.

fn get_bool( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&bool>, Dim<IxDynImpl>>>

Gets a bool array view from a column inside a block.

fn get_uint( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&u32>, Dim<IxDynImpl>>>

Gets a uint array view from a column inside a block.

fn get_u8( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&u8>, Dim<IxDynImpl>>>

Gets a u8 array view from a column inside a block.

fn get_string( &self, block_key: &str, col_key: &str, ) -> Option<ArrayBase<ViewRepr<&String>, Dim<IxDynImpl>>>

Gets a string array view from a column inside a block.

fn simbox_ref(&self) -> Option<&SimBox>

Returns a reference to the simulation box, if present.

fn meta_ref(&self) -> &HashMap<String, String>

Returns a reference to the metadata map.

fn block_keys(&self) -> Vec<&str>

Returns block keys as a Vec.

fn contains_block(&self, key: &str) -> bool

Returns true if the frame contains the specified block key.

fn block_count(&self) -> usize

Number of blocks.

fn is_empty(&self) -> bool

Returns true if the frame contains no blocks.

fn visit_block<R>( &self, key: &str, f: impl FnOnce(&dyn BlockAccess) -> R, ) -> Option<R>

Visits a block by key through the BlockAccess trait, using the visitor pattern to avoid lifetime/return-type issues. Returns None if the block does not exist.

impl<'a> From<&'a Frame> for FrameView<'a>

fn from(frame: &'a Frame) -> FrameView<'a>

Converts to this type from the input type.