Struct rustronomy_core::universal_containers::table::Table

pub struct Table { /* private fields */ }

the table data container. Consists of named columns and metadata tags. See the module-level documentation for more details.

Implementations

impl Table

pub fn new() -> Table

creates an empty table without metadata

pub fn set_col(&mut self, col_name: &str, col: Col)

adds column to the table and gives it a name, if specified. If a column with the same name already exists, it will be overridden.

pub fn get_col(&self, col_name: &str) -> Option<&Col>

returns reference to the column with the name col_name if one exists, None otherwise.

pub fn get_col_mut(&mut self, col_name: &str) -> Option<&mut Col>

returns mutable reference to the column with the name col_name if one exists, None otherwise.

pub fn remove_col(&mut self, col_name: &str) -> Option<Col>

removes column with the name col_name if one exists and returns it. Returns None if no column named col_name exists.

pub fn data(self) -> Vec<(String, Col)>

returns vec of (column-name, column) pairs, discarding the metadata tags

pub fn data_unnamed(self) -> Vec<Col>

returns vec of columns discarding column names and metadata tags

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Display for Table

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

Formats the value using the given formatter.

impl<T> MetaDataContainer<T> for Table where
    T: Display + Sized + Send + Sync + FromStr,
    <T as FromStr>::Err: Debug, 

fn set_generic_tag(
    &mut self,
    tag: GenericMetaDataTag<T>
) -> Result<(), MetaDataErr>

adds a generic metadata tag to a data container. Returns an error if the supplied tag is reserved. If the tag already exists, the old value will be overridden.

fn get_tag(&self, key: &str) -> Option<GenericMetaDataTag<T>>

returns a copy of the tag associated with the supplied key, if it exists. reserved tags cannot be changed manually, but can be copied without any issues. Therefore, you may supply a restricted key to this function.

fn remove_generic_tag(
    &mut self,
    key: &str
) -> Result<GenericMetaDataTag<T>, MetaDataErr>

removes a generic metadata tag from a data container. Returns an error if the supplied tag is reserved or if the tag does not exist.

fn set_author(&mut self, author: &str) -> Result<(), MetaDataErr>

fn get_author(&self) -> Option<String>

fn remove_author(&mut self) -> Result<(), MetaDataErr>