Skip to main content

TypeSchema

Struct TypeSchema 

Source
pub struct TypeSchema {
    pub id: SchemaId,
    pub name: String,
    pub fields: Vec<FieldDef>,
    pub data_size: usize,
    pub component_types: Option<Vec<String>>,
    pub enum_info: Option<EnumInfo>,
    pub content_hash: Option<[u8; 32]>,
    /* private fields */
}
Expand description

Schema describing the memory layout of a declared type

Fields§

§id: SchemaId

Unique schema identifier

§name: String

Type name (e.g., “Candle”, “Trade”)

§fields: Vec<FieldDef>

Field definitions with computed offsets

§data_size: usize

Total size of the object data in bytes (excluding header)

§component_types: Option<Vec<String>>

Component types (for intersection types, tracks which types were merged) Maps field name to the source type name for decomposition

§enum_info: Option<EnumInfo>

Enum-specific information (if this is an enum type)

§content_hash: Option<[u8; 32]>

Content hash (SHA-256) derived from structural definition. Computed lazily and cached. Skipped during serialization since it is derived.

Implementations§

Source§

impl TypeSchema

Source

pub fn from_intersection( name: impl Into<String>, schemas: &[&TypeSchema], ) -> Result<Self, SchemaError>

Create an intersection type schema by merging multiple schemas. Returns an error if any field names collide.

Source

pub fn is_intersection(&self) -> bool

Check if this schema is an intersection type

Source

pub fn get_component_types(&self) -> Option<&[String]>

Get the component types if this is an intersection

Source

pub fn field_source(&self, field_name: &str) -> Option<&str>

Get the source type for a field (for decomposition)

Source

pub fn fields_for_component(&self, component_name: &str) -> Vec<&FieldDef>

Get fields belonging to a specific component type (for decomposition)

Source§

impl TypeSchema

Source

pub fn new( name: impl Into<String>, field_defs: Vec<(String, FieldType)>, ) -> Self

Create a new type schema with the given fields

Source

pub fn get_field(&self, name: &str) -> Option<&FieldDef>

Get field definition by name

Source

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

Get field offset by name (returns None if field doesn’t exist)

Source

pub fn field_index(&self, name: &str) -> Option<u16>

Get field index by name

Source

pub fn field_by_index(&self, index: u16) -> Option<&FieldDef>

Get field by index

Source

pub fn field_count(&self) -> usize

Number of fields in this schema

Source

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

Check if schema has a field with the given name

Source

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

Iterator over field names

Source

pub fn is_enum(&self) -> bool

Check if this schema is for an enum type

Source

pub fn get_enum_info(&self) -> Option<&EnumInfo>

Get enum info if this is an enum type

Source

pub fn variant_id(&self, variant_name: &str) -> Option<u16>

Get variant ID by name (for enum types)

Source

pub fn new_enum(name: impl Into<String>, variants: Vec<EnumVariantInfo>) -> Self

Create an enum schema with variant information

Layout:

  • Field 0: __variant (I64) - variant discriminator at offset 0
  • Field 1+: __payload_N (Any) - payload fields at offset 8, 16, etc.
Source

pub fn compute_content_hash(&self) -> [u8; 32]

Compute the content hash (SHA-256) from the structural definition.

The hash is derived deterministically from:

  • The type name
  • Fields sorted by name, each contributing field name + field type string
  • Enum variant info (if present), sorted by variant name

For recursive type references (Object("Foo")), only the type name is hashed to avoid infinite recursion.

Source

pub fn content_hash(&mut self) -> [u8; 32]

Return the cached content hash, computing and caching it if needed.

Source

pub fn bind_to_arrow_schema( &self, arrow_schema: &ArrowSchema, ) -> Result<TypeBinding, TypeBindingError>

Bind this TypeSchema to an Arrow schema, producing a TypeBinding.

Validates that every field in the TypeSchema has a compatible column in the Arrow schema. Returns a mapping from TypeSchema field index → Arrow column index.

Source

pub fn from_canonical(canonical: &CanonicalType) -> Self

Create a type schema from a canonical type (for evolved types)

This converts the semantic CanonicalType representation into a JIT-ready TypeSchema with proper field offsets and types.

Trait Implementations§

Source§

impl Clone for TypeSchema

Source§

fn clone(&self) -> TypeSchema

Returns a duplicate 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 Debug for TypeSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TypeSchema

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TypeSchema

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,