Struct DatasetConfig

pub struct DatasetConfig {
    pub tables: UniqueList<TableConfig>,
}

Struct to manage the config for a given database. At connection time, the Driver will retrieve config from Vitur for the currently connected database

Fields

tables: UniqueList<TableConfig>

Implementations

impl DatasetConfig

pub fn init() -> DatasetConfig

pub fn add_table( self, config: TableConfig, ) -> Result<DatasetConfig, ConfigError>

pub fn has_table<Q>(&self, query: &Q) -> bool

where TableConfig: PartialEq<Q>,

Returns true if a table matches the given query

pub fn get_table<Q>(&self, query: &Q) -> Option<&TableConfig>

where TableConfig: PartialEq<Q>,

Finds a table that matches query

pub fn sort_indexes_by_type(self) -> DatasetConfig

Sorts all indexes by type for each field in each table. Indexes are sorted in place.

This is useful for ensuring that iteration over indexes always occurs in order by type (instead of the order that they appear in a config file or the order of ColumnConfig::add_index calls).

Trait Implementations

impl Clone for DatasetConfig

fn clone(&self) -> DatasetConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatasetConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatasetConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DatasetConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.