Struct tc_table::IndexSchema

pub struct IndexSchema { /* private fields */ }

The schema of a Table index

Implementations

impl IndexSchema

pub fn columns(&self) -> Vec<Column>

Return a list of the columns in this schema.

pub fn column_names(&self) -> impl Iterator<Item = &Id>

Iterate over the names of the columns in this schema.

pub fn key(&self) -> &[Column]

Return a slice of the columns in this schema’s key.

pub fn values(&self) -> &[Column]

Return a slice of the columns in this schema’s values.

pub fn len(&self) -> usize

Return the number of columns in this schema.

pub fn key_from_row(&self, row: &Row) -> TCResult<Key>

Given a Row, return its key.

pub fn key_values_from_row(
    &self,
    row: Row,
    reject_extras: bool
) -> TCResult<(Key, Values)>

Given a Row, return a (key, values) tuple.

pub fn key_values_from_tuple(
    &self,
    tuple: Tuple<Value>
) -> TCResult<(Vec<Value>, Vec<Value>)>

Given a Row, return a (key, values) tuple.

pub fn row_from_key_values(&self, key: Key, values: Values) -> TCResult<Row>

Given a key and values, return a Row.

pub fn row_from_values(&self, values: Values) -> TCResult<Row>

Given a list of Values, return a Row.

pub fn starts_with(&self, expected: &[Id]) -> bool

Return true if this schema starts with the given slice of column names.

pub fn auxiliary(&self, key: &[Id]) -> TCResult<IndexSchema>

Return the IndexSchema needed to index the given columns.

pub fn validate_columns(&self, columns: &[Id]) -> TCResult<()>

Return an error if this schema does not support ordering by the given columns.

pub fn validate_key(&self, key: Key) -> TCResult<Key>

Return an error if the given key does not match this schema.

pub fn validate_values(&self, values: Values) -> TCResult<Key>

Return an error if the given values do not match this schema.

pub fn validate_row_partial(&self, row: Row) -> TCResult<Row>

Return an error if the given Row has any extra fields or incompatible values.

pub fn validate_row(&self, row: Row) -> TCResult<Row>

Return an error if the given Row does not have a compatible value for every column.

pub fn values_from_row(
    &self,
    row: Row,
    reject_extras: bool
) -> TCResult<Vec<Value>>

Given a Row, return an ordered list of Values.

Trait Implementations

impl CastFrom<IndexSchema> for Value

fn cast_from(schema: IndexSchema) -> Self

Cast an instance of T into an instance of Self.

impl Clone for IndexSchema

fn clone(&self) -> IndexSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for IndexSchema

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

Formats the value using the given formatter.

impl From<(Vec<Column, Global>, Vec<Column, Global>)> for IndexSchema

fn from(schema: (Vec<Column>, Vec<Column>)) -> IndexSchema

Converts to this type from the input type.

impl From<IndexSchema> for Map<Column>

fn from(schema: IndexSchema) -> Map<Column>

Converts to this type from the input type.

impl From<IndexSchema> for RowSchema

fn from(schema: IndexSchema) -> RowSchema

Converts to this type from the input type.

impl From<IndexSchema> for TableSchema

fn from(schema: IndexSchema) -> TableSchema

Converts to this type from the input type.

impl FromStream for IndexSchema

type Context = ()

The decoding context of this type, useful in situations where the stream to be decoded may be too large to hold in main memory.

fn from_stream<'life0, 'async_trait, D>(
    cxt: (),
    decoder: &'life0 mut D
) -> Pin<Box<dyn Future<Output = Result<Self, D::Error>> + Send + 'async_trait>>where
    D: 'async_trait + Decoder,
    Self: 'async_trait,
    'life0: 'async_trait,

Parse this value using the given Decoder.

impl<'en> IntoStream<'en> for IndexSchema

fn into_stream<E: Encoder<'en>>(self, encoder: E) -> Result<E::Ok, E::Error>

Take ownership of this value and serialize it into the given encoder.

impl PartialEq<IndexSchema> for IndexSchema

fn eq(&self, other: &IndexSchema) -> 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<'en> ToStream<'en> for IndexSchema

fn to_stream<E: Encoder<'en>>(&'en self, encoder: E) -> Result<E::Ok, E::Error>

Serialize this value into the given encoder.

impl TryCastFrom<Value> for IndexSchema

fn can_cast_from(value: &Value) -> bool

Test if value can be cast into Self.

fn opt_cast_from(value: Value) -> Option<IndexSchema>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>where
    OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

impl Eq for IndexSchema

impl StructuralEq for IndexSchema

impl StructuralPartialEq for IndexSchema