Struct Schema 

pub struct Schema { /* private fields */ }

Names and types of fields in a table.

Implementations

impl Schema

Auto-generated by derive_getters::Getters.

pub fn schema_id(&self) -> &i32

Identifier of the schema

pub fn identifier_field_ids(&self) -> &Option<Vec<i32>>

Set of primitive fields that identify rows in a table.

pub fn fields(&self) -> &StructType

The struct fields

impl Schema

pub fn builder() -> SchemaBuilder

Creates a new SchemaBuilder to construct a Schema using the builder pattern

Returns

• A SchemaBuilder instance configured with default values

This is the recommended way to construct Schema instances when you need to add fields incrementally or set optional parameters.

pub fn from_struct_type( fields: StructType, schema_id: i32, identifier_field_ids: Option<Vec<i32>>, ) -> Self

Creates a new Schema from a StructType and associated metadata

Arguments

• fields - The StructType containing the schema’s fields
• schema_id - Unique identifier for this schema
• identifier_field_ids - Optional list of field IDs that identify rows in the table

Returns

• A new Schema instance with the provided fields and metadata

pub fn project(&self, ids: &[i32]) -> Schema

Creates a new Schema containing only the specified field IDs

Arguments

• ids - Array of field IDs to include in the projected schema

Returns

• A new Schema containing only the specified fields, maintaining the original schema ID and any identifier fields that were included in the projection

Methods from Deref<Target = StructType>

pub fn get(&self, index: usize) -> Option<&StructField>

Gets a reference to the StructField at the given index

Arguments

• index - The index of the field to retrieve

Returns

• Some(&StructField) if a field exists at that index
• None if no field exists at that index

pub fn get_name(&self, name: &str) -> Option<&StructField>

Gets a reference to the StructField with the given name

Arguments

• name - The name of the field to retrieve

Returns

• Some(&StructField) if a field with the given name exists
• None if no field with that name exists

pub fn len(&self) -> usize

Returns the number of fields in this struct

Returns

• The total count of StructFields contained in this struct

pub fn is_empty(&self) -> bool

Returns true if the struct contains no fields

Returns

• true if this struct has no fields
• false if this struct has at least one field

pub fn iter(&self) -> Iter<'_, StructField>

Returns an iterator over all fields in this struct

Returns

• An iterator yielding references to each StructField in order

pub fn field_ids(&self) -> impl Iterator<Item = i32>

Returns an iterator over all field IDs in this struct, sorted in ascending order

Returns

• An iterator yielding field IDs (i32) in sorted order

pub fn primitive_field_ids(&self) -> impl Iterator<Item = i32>

Returns an iterator over field IDs of primitive-type fields only, sorted in ascending order

This method filters the struct’s fields to return only those with primitive types (boolean, numeric, string, etc.), excluding complex types like structs, lists, and maps.

Returns

• An iterator yielding field IDs (i32) of primitive fields in sorted order

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

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 = StructType

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Schema

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

Formats the value using the given formatter.

impl From<Schema> for SchemaV1

fn from(value: Schema) -> Self

Converts to this type from the input type.

impl From<Schema> for SchemaV2

fn from(value: Schema) -> Self

Converts to this type from the input type.

impl FromStr for Schema

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Schema

fn eq(&self, other: &Schema) -> 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 Serialize for Schema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SchemaV1> for Schema

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SchemaV1) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SchemaV2> for Schema

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SchemaV2) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Schema

impl StructuralPartialEq for Schema