Struct lace_codebook::ColMetadataList

pub struct ColMetadataList { /* private fields */ }

A structure that enforces unique IDs and names.

#Notes Serializes to a Vec of ColMetadata and deserializes to a Vec of ColMetadata.

Implementations

impl ColMetadataList

pub fn new(metadata: Vec<ColMetadata>) -> Result<Self, String>

Create a new ColMetadataList. Returns an error – the column name – if any of the ColMetadatas’ are not unique (case sensitive).

pub fn push(&mut self, md: ColMetadata) -> Result<(), String>

Append a new column to the end of the list. Returns an error if the column’s name already exists.

pub fn iter(&self) -> Iter<'_, ColMetadata>

Iterate through the column metadata

pub fn len(&self) -> usize

The number of columns

pub fn is_empty(&self) -> bool

True if there are no columns

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

True if one of the columns has name

pub fn name(&self, ix: usize) -> Option<&String>

Get the name of the column at index ix if it exists

pub fn get(&self, name: &str) -> Option<(usize, &ColMetadata)>

Return the integer index and the metadata of the column with name if it exists. Otherwise return None.

pub fn take(&mut self, name: &str) -> Option<ColMetadata>

Take the column metadata with given key

pub fn remove_by_index(&mut self, ix: usize)

Remove the entries at ix and re-index

Trait Implementations

impl Clone for ColMetadataList

fn clone(&self) -> ColMetadataList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColMetadataList

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

Formats the value using the given formatter.

impl Default for ColMetadataList

fn default() -> ColMetadataList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ColMetadataList

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ColMetadataList> for Vec<ColMetadata>

fn from(cols: ColMetadataList) -> Self

Converts to this type from the input type.

impl Index<usize> for ColMetadataList

type Output = ColMetadata

The returned type after indexing.

fn index(&self, ix: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for ColMetadataList

fn index_mut(&mut self, ix: usize) -> &mut ColMetadata

Performs the mutable indexing (container[index]) operation.

impl PartialEq<ColMetadataList> for ColMetadataList

fn eq(&self, other: &ColMetadataList) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ColMetadataList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec<ColMetadata, Global>> for ColMetadataList

type Error = ColMetadataListError

The type returned in the event of a conversion error.

fn try_from(mds: Vec<ColMetadata>) -> Result<ColMetadataList, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ColMetadataList