Struct tc_table::IndexSchema

source · [−]

pub struct IndexSchema { /* private fields */ }

Expand description

The schema of a Table index

Implementations

source

impl IndexSchema

source

pub fn columns(&self) -> Vec<Column>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return a list of the columns in this schema.

source

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

Iterate over the names of the columns in this schema.

source

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

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

source

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

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

source

pub fn len(&self) -> usize

Return the number of columns in this schema.

source

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

Given a Row, return its key.

source

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

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

source

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

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

source

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

Given a key and values, return a Row.

source

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

Given a list of Values, return a Row.

source

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

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

source

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

Return the IndexSchema needed to index the given columns.

source

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

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

source

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

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

source

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

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

source

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

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

source

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.

source

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

source

impl CastFrom<IndexSchema> for Value

source

fn cast_from(schema: IndexSchema) -> Self

Cast an instance of T into an instance of Self.

source

impl Clone for IndexSchema

source

fn clone(&self) -> IndexSchema

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Display for IndexSchema

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Performs the conversion.

source

impl From<IndexSchema> for Map<Column>

source

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

Performs the conversion.

source

impl From<IndexSchema> for RowSchema

source

fn from(schema: IndexSchema) -> RowSchema

Performs the conversion.

source

impl From<IndexSchema> for TableSchema

source

fn from(schema: IndexSchema) -> TableSchema

Performs the conversion.

source

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. Read more

source

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

Parse this value using the given Decoder.

source

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

source

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.

source

impl PartialEq<IndexSchema> for IndexSchema

source

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

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

source

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

This method tests for !=.

source

impl TryCastFrom<Value> for IndexSchema

source

fn can_cast_from(value: &Value) -> bool

Test if value can be cast into Self.

source

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

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

source

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.

source

impl Eq for IndexSchema

source

impl StructuralEq for IndexSchema

source

impl StructuralPartialEq for IndexSchema

Auto Trait Implementations

impl RefUnwindSafe for IndexSchema

impl Send for IndexSchema

impl Sync for IndexSchema

impl Unpin for IndexSchema

impl UnwindSafe for IndexSchema

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<F, T> CastFrom<F> for T where
T: From<F>,

source

pub fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.

source

impl<T, F> CastInto<F> for T where
F: CastFrom<T>,

source

pub fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<F> Match for F

source

fn matches<T>(&self) -> bool where
T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<F, T> TryCastFrom<F> for T where
T: CastFrom<F>,

source

pub fn can_cast_from(&F) -> bool

Test if value can be cast into Self.

source

pub fn opt_cast_from(f: F) -> Option<T>

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

source

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.

source

impl<F, T> TryCastInto<T> for F where
T: TryCastFrom<F>,

source

pub fn can_cast_into(&self) -> bool

Test if self can be cast into T.

source

pub fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.

source

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

Returns Ok(T) if self can be cast into T, otherwise calls on_err.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tc_table::IndexSchema

Implementations

impl IndexSchema

pub fn columns(&self) -> Vec<Column>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

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

pub fn len(&self) -> usize

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl CastFrom<IndexSchema> for Value

fn cast_from(schema: IndexSchema) -> Self

impl Clone for IndexSchema

fn clone(&self) -> IndexSchema

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

impl Display for IndexSchema

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

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

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

impl From<IndexSchema> for Map<Column>

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

impl From<IndexSchema> for RowSchema

fn from(schema: IndexSchema) -> RowSchema

impl From<IndexSchema> for TableSchema

fn from(schema: IndexSchema) -> TableSchema

impl FromStream for IndexSchema

type Context = ()

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

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

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

impl PartialEq<IndexSchema> for IndexSchema

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

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

impl TryCastFrom<Value> for IndexSchema

fn can_cast_from(value: &Value) -> bool

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

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

impl Eq for IndexSchema

impl StructuralEq for IndexSchema

impl StructuralPartialEq for IndexSchema

Auto Trait Implementations

impl RefUnwindSafe for IndexSchema

impl Send for IndexSchema

impl Sync for IndexSchema

impl Unpin for IndexSchema

impl UnwindSafe for IndexSchema

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<F, T> CastFrom<F> for T where T: From<F>,

pub fn cast_from(f: F) -> T

impl<T, F> CastInto<F> for T where F: CastFrom<T>,

pub fn cast_into(self) -> F

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<F> Match for F

fn matches<T>(&self) -> bool where T: TryCastFrom<Self>,

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn columns(&self) -> Vec<Column>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<F, T> CastFrom<F> for T where
T: From<F>,

impl<T, F> CastInto<F> for T where
F: CastFrom<T>,

impl<T, U> Into<U> for T where
U: From<T>,

fn matches<T>(&self) -> bool where
T: TryCastFrom<Self>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<F, T> TryCastFrom<F> for T where
T: CastFrom<F>,

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

impl<F, T> TryCastInto<T> for F where
T: TryCastFrom<F>,

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,