Struct Schema 

pub struct Schema(/* private fields */);

A schema describing the structure of encoded row data.

Implementations

impl Schema

pub fn set_any(&self, row: &mut EncodedValues, index: usize, value: &Value)

pub fn get_any(&self, row: &EncodedValues, index: usize) -> Value

impl Schema

pub fn set_blob(&self, row: &mut EncodedValues, index: usize, value: &Blob)

pub fn get_blob(&self, row: &EncodedValues, index: usize) -> Blob

pub fn try_get_blob(&self, row: &EncodedValues, index: usize) -> Option<Blob>

impl Schema

pub fn set_bool( &self, row: &mut EncodedValues, index: usize, value: impl Into<bool>, )

pub fn get_bool(&self, row: &EncodedValues, index: usize) -> bool

pub fn try_get_bool(&self, row: &EncodedValues, index: usize) -> Option<bool>

impl Schema

pub fn set_date(&self, row: &mut EncodedValues, index: usize, value: Date)

pub fn get_date(&self, row: &EncodedValues, index: usize) -> Date

pub fn try_get_date(&self, row: &EncodedValues, index: usize) -> Option<Date>

impl Schema

pub fn set_datetime( &self, row: &mut EncodedValues, index: usize, value: DateTime, )

pub fn get_datetime(&self, row: &EncodedValues, index: usize) -> DateTime

pub fn try_get_datetime( &self, row: &EncodedValues, index: usize, ) -> Option<DateTime>

impl Schema

pub fn set_decimal( &self, row: &mut EncodedValues, index: usize, value: &Decimal, )

Set a Decimal value with 2-tier storage optimization

• Values that fit in i128: stored inline with MSB=0
• Large values: stored in dynamic section with MSB=1

pub fn get_decimal(&self, row: &EncodedValues, index: usize) -> Decimal

Get a Decimal value, detecting storage mode from MSB

pub fn try_get_decimal( &self, row: &EncodedValues, index: usize, ) -> Option<Decimal>

Try to get a Decimal value, returning None if undefined

impl Schema

pub fn set_dictionary_id( &self, row: &mut EncodedValues, index: usize, entry: &DictionaryEntryId, )

pub fn get_dictionary_id( &self, row: &EncodedValues, index: usize, ) -> DictionaryEntryId

pub fn try_get_dictionary_id( &self, row: &EncodedValues, index: usize, ) -> Option<DictionaryEntryId>

impl Schema

pub fn set_duration( &self, row: &mut EncodedValues, index: usize, value: Duration, )

pub fn get_duration(&self, row: &EncodedValues, index: usize) -> Duration

pub fn try_get_duration( &self, row: &EncodedValues, index: usize, ) -> Option<Duration>

impl Schema

pub fn set_f32( &self, row: &mut EncodedValues, index: usize, value: impl Into<f32>, )

pub fn get_f32(&self, row: &EncodedValues, index: usize) -> f32

pub fn try_get_f32(&self, row: &EncodedValues, index: usize) -> Option<f32>

impl Schema

pub fn set_f64( &self, row: &mut EncodedValues, index: usize, value: impl Into<f64>, )

pub fn get_f64(&self, row: &EncodedValues, index: usize) -> f64

pub fn try_get_f64(&self, row: &EncodedValues, index: usize) -> Option<f64>

impl Schema

pub fn set_i128( &self, row: &mut EncodedValues, index: usize, value: impl Into<i128>, )

pub fn get_i128(&self, row: &EncodedValues, index: usize) -> i128

pub fn try_get_i128(&self, row: &EncodedValues, index: usize) -> Option<i128>

impl Schema

pub fn set_i16( &self, row: &mut EncodedValues, index: usize, value: impl Into<i16>, )

pub fn get_i16(&self, row: &EncodedValues, index: usize) -> i16

pub fn try_get_i16(&self, row: &EncodedValues, index: usize) -> Option<i16>

impl Schema

pub fn set_i32( &self, row: &mut EncodedValues, index: usize, value: impl Into<i32>, )

pub fn get_i32(&self, row: &EncodedValues, index: usize) -> i32

pub fn try_get_i32(&self, row: &EncodedValues, index: usize) -> Option<i32>

impl Schema

pub fn set_i64( &self, row: &mut EncodedValues, index: usize, value: impl Into<i64>, )

pub fn get_i64(&self, row: &EncodedValues, index: usize) -> i64

pub fn try_get_i64(&self, row: &EncodedValues, index: usize) -> Option<i64>

impl Schema

pub fn set_i8( &self, row: &mut EncodedValues, index: usize, value: impl Into<i8>, )

pub fn get_i8(&self, row: &EncodedValues, index: usize) -> i8

pub fn try_get_i8(&self, row: &EncodedValues, index: usize) -> Option<i8>

impl Schema

pub fn set_identity_id( &self, row: &mut EncodedValues, index: usize, value: IdentityId, )

pub fn get_identity_id(&self, row: &EncodedValues, index: usize) -> IdentityId

pub fn try_get_identity_id( &self, row: &EncodedValues, index: usize, ) -> Option<IdentityId>

impl Schema

pub fn set_int(&self, row: &mut EncodedValues, index: usize, value: &Int)

Set a Int value with 2-tier storage optimization

• Values fitting in 127 bits: stored inline with MSB=0
• Large values: stored in dynamic section with MSB=1

pub fn get_int(&self, row: &EncodedValues, index: usize) -> Int

Get a Int value, detecting storage mode from MSB

pub fn try_get_int(&self, row: &EncodedValues, index: usize) -> Option<Int>

Try to get a Int value, returning None if undefined

impl Schema

pub fn new(fields: Vec<SchemaField>) -> Self

Create a new schema from a list of fields.

This computes the memory layout (offsets, alignment) and fingerprint.

pub fn from_parts( fingerprint: SchemaFingerprint, fields: Vec<SchemaField>, ) -> Self

Create a schema from pre-computed fields and fingerprint. Used when loading from storage.

pub fn fingerprint(&self) -> SchemaFingerprint

Get the schema’s fingerprint

pub fn fields(&self) -> &[SchemaField]

Get the fields in this schema

pub fn field_count(&self) -> usize

Get the number of fields

pub fn find_field(&self, name: &str) -> Option<&SchemaField>

Find a field by name

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

Find field index by name

pub fn get_field(&self, index: usize) -> Option<&SchemaField>

Find a field by index

pub fn get_field_name(&self, index: usize) -> Option<&str>

Get field name by index

pub fn field_names(&self) -> impl Iterator<Item = &str>

Get all field names as an iterator

pub fn bitvec_size(&self) -> usize

Size of the bitvec section in bytes

pub fn data_offset(&self) -> usize

Offset where field data starts (after header and bitvec)

pub fn total_static_size(&self) -> usize

Total size of the static section

pub fn dynamic_section_start(&self) -> usize

Start of the dynamic section

pub fn dynamic_section_size(&self, row: &EncodedValues) -> usize

Size of the dynamic section

pub fn allocate(&self) -> EncodedValues

Allocate a new encoded row

pub fn set_none(&self, row: &mut EncodedValues, index: usize)

Set a field as undefined (not set)

pub fn testing(types: &[Type]) -> Self

Create a schema from a list of types. Fields are named f0, f1, f2, etc. and have unconstrained types. Useful for tests and simple state schemas.

impl Schema

pub fn set_time(&self, row: &mut EncodedValues, index: usize, value: Time)

pub fn get_time(&self, row: &EncodedValues, index: usize) -> Time

pub fn try_get_time(&self, row: &EncodedValues, index: usize) -> Option<Time>

impl Schema

pub fn set_u128( &self, row: &mut EncodedValues, index: usize, value: impl Into<u128>, )

pub fn get_u128(&self, row: &EncodedValues, index: usize) -> u128

pub fn try_get_u128(&self, row: &EncodedValues, index: usize) -> Option<u128>

impl Schema

pub fn set_u16( &self, row: &mut EncodedValues, index: usize, value: impl Into<u16>, )

pub fn get_u16(&self, row: &EncodedValues, index: usize) -> u16

pub fn try_get_u16(&self, row: &EncodedValues, index: usize) -> Option<u16>

impl Schema

pub fn set_u32( &self, row: &mut EncodedValues, index: usize, value: impl Into<u32>, )

pub fn get_u32(&self, row: &EncodedValues, index: usize) -> u32

pub fn try_get_u32(&self, row: &EncodedValues, index: usize) -> Option<u32>

impl Schema

pub fn set_u64( &self, row: &mut EncodedValues, index: usize, value: impl Into<u64>, )

pub fn get_u64(&self, row: &EncodedValues, index: usize) -> u64

pub fn try_get_u64(&self, row: &EncodedValues, index: usize) -> Option<u64>

impl Schema

pub fn set_u8( &self, row: &mut EncodedValues, index: usize, value: impl Into<u8>, )

pub fn get_u8(&self, row: &EncodedValues, index: usize) -> u8

pub fn try_get_u8(&self, row: &EncodedValues, index: usize) -> Option<u8>

impl Schema

pub fn set_uint(&self, row: &mut EncodedValues, index: usize, value: &Uint)

Set a Uint value with 2-tier storage optimization

• Values fitting in 127 bits: stored inline with MSB=0
• Large values: stored in dynamic section with MSB=1

pub fn get_uint(&self, row: &EncodedValues, index: usize) -> Uint

Get a Uint value, detecting storage mode from MSB

pub fn try_get_uint(&self, row: &EncodedValues, index: usize) -> Option<Uint>

Try to get a Uint value, returning None if undefined

impl Schema

pub fn set_utf8( &self, row: &mut EncodedValues, index: usize, value: impl AsRef<str>, )

pub fn get_utf8<'a>(&'a self, row: &'a EncodedValues, index: usize) -> &'a str

pub fn try_get_utf8<'a>( &'a self, row: &'a EncodedValues, index: usize, ) -> Option<&'a str>

impl Schema

pub fn set_uuid4(&self, row: &mut EncodedValues, index: usize, value: Uuid4)

pub fn get_uuid4(&self, row: &EncodedValues, index: usize) -> Uuid4

pub fn try_get_uuid4(&self, row: &EncodedValues, index: usize) -> Option<Uuid4>

impl Schema

pub fn set_uuid7(&self, row: &mut EncodedValues, index: usize, value: Uuid7)

pub fn get_uuid7(&self, row: &EncodedValues, index: usize) -> Uuid7

pub fn try_get_uuid7(&self, row: &EncodedValues, index: usize) -> Option<Uuid7>

impl Schema

pub fn set_values(&self, row: &mut EncodedValues, values: &[Value])

pub fn set_value(&self, row: &mut EncodedValues, index: usize, val: &Value)

pub fn get_value(&self, row: &EncodedValues, index: usize) -> Value

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Deref for Schema

type Target = Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&[ColumnDef]> for Schema

fn from(value: &[ColumnDef]) -> Self

Converts to this type from the input type.

impl From<&[SubscriptionColumnDef]> for Schema

fn from(value: &[SubscriptionColumnDef]) -> Self

Converts to this type from the input type.

impl From<&SubscriptionDef> for Schema

fn from(value: &SubscriptionDef) -> Self

Converts to this type from the input type.

impl From<&Vec<ColumnDef>> for Schema

fn from(value: &Vec<ColumnDef>) -> Self

Converts to this type from the input type.

impl From<&Vec<SubscriptionColumnDef>> for Schema

fn from(value: &Vec<SubscriptionColumnDef>) -> Self

Converts to this type from the input type.

impl PartialEq for Schema

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Schema