Struct SchemaDescriptor 

pub struct SchemaDescriptor { /* private fields */ }

A validated, versioned collection schema.

Implementations

impl SchemaDescriptor

pub fn new( collection_name: impl Into<String>, version: u32, fields: Vec<FieldDescriptor>, ) -> Result<SchemaDescriptor, SchemaError>

Validates and constructs a collection schema.

pub fn collection_name(&self) -> &str

Returns the human-readable declared collection name.

pub const fn collection_id(&self) -> CollectionId

Returns the stable collection identifier.

pub const fn version(&self) -> u32

Returns the application-controlled schema version.

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

Returns fields in canonical numeric-ID order.

pub fn schema_id(&self) -> SchemaId

Returns the domain-separated hash of the canonical descriptor.

pub fn encode_canonical(&self) -> Vec<u8>

Encodes the descriptor into its durable canonical representation.

pub fn decode_canonical(bytes: &[u8]) -> Result<SchemaDescriptor, SchemaError>

Decodes and validates an exact canonical descriptor.

Trait Implementations

impl Clone for SchemaDescriptor

fn clone(&self) -> SchemaDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDescriptor

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

Formats the value using the given formatter.

impl PartialEq for SchemaDescriptor

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

impl StructuralPartialEq for SchemaDescriptor