Struct MetadataSchema

Source

pub struct MetadataSchema { /* private fields */ }

Expand description

Schema for metadata fields.

A schema declares valid keys, their concrete DataType, and whether they are required. It can validate actual Metadata values and validate that a crate::MetadataFilter references known fields with compatible operators.

§Examples

use qubit_datatype::DataType;
use qubit_metadata::Metadata;
use qubit_metadata::MetadataSchema;

let metadata = Metadata::new().with("tenant", "acme");
let schema = MetadataSchema::builder()
    .required("tenant", DataType::String)
    .build()?;
schema.validate(&metadata)?;

Implementations§

Source §

impl MetadataSchema

Source

pub fn validate_filter( &self, filter: &MetadataFilter, ) -> MetadataValidationResult<()>

Validates a metadata filter against this schema.

§Parameters

filter - Filter to validate.

§Returns

Ok(()) when every condition is compatible with this schema.

§Errors

Returns an aggregate error containing every unknown field, invalid range operator, and incompatible filter value discovered during this validation pass. Unknown filter fields are accepted when the schema’s UnknownFilterFieldPolicy is UnknownFilterFieldPolicy::AllowUnchecked.

Source §

impl MetadataSchema

Source

pub fn builder() -> MetadataSchemaBuilder

Creates a schema builder.

§Returns

An empty schema builder using the default unknown-field policy.

Source

pub fn decode_json_slice(input: &[u8]) -> Result<Self, MetadataWireDecodeError>

Decodes a strict metadata-schema JSON envelope using the metadata profile.

§Parameters

input - Complete untrusted JSON input.

§Returns

The decoded metadata schema.

§Errors

Returns a structured budget error or InvalidJson for malformed strict schema input.

Source

pub fn decode_json_slice_with_limits( input: &[u8], limits: MetadataLimits, ) -> Result<Self, MetadataWireDecodeError>

Decodes a strict metadata-schema JSON envelope after applying limits.

§Parameters

input - Complete untrusted JSON input.
limits - Shared JSON limits for this decoding session.

§Returns

The decoded metadata schema.

§Errors

Returns a structured budget error, Domain for field/key limits, UnsupportedVersion for version mismatches, or redacted JSON errors for syntax and other strict schema-envelope failures.

Source

pub fn to_json_vec(&self) -> Result<Vec<u8>, MetadataWireEncodeError>

Encodes this schema with the default JSON budget profile.

Source

pub fn to_json_vec_with_limits( &self, limits: JsonEncodeLimits, ) -> Result<Vec<u8>, MetadataWireEncodeError>

Encodes this schema with caller-provided JSON budgets.

§Parameters

limits - Output and JSON-value budgets for this operation.

§Errors

Returns crate::MetadataWireEncodeError when encoding exceeds a budget or serialization fails.

Source

pub fn to_json_writer<W>( &self, writer: W, ) -> Result<(), MetadataWireEncodeError>
where W: Write,

Encodes this schema to a writer with the default JSON budget profile.

Source

pub fn to_json_writer_with_limits<W>( &self, writer: W, limits: JsonEncodeLimits, ) -> Result<(), MetadataWireEncodeError>
where W: Write,

Encodes this schema to a writer with caller-provided JSON budgets.

§Parameters

writer - Destination receiving the compact JSON document.
limits - Output and JSON-value budgets for this operation.

§Errors

Returns crate::MetadataWireEncodeError when encoding exceeds a budget, serialization fails, or writer rejects the output.

Source

pub fn field(&self, key: &str) -> Option<&MetadataField>

Returns the field definition for key.

§Parameters

key - Metadata key to look up.

§Returns

Some field definition for a declared key; otherwise, None.

Source

pub fn field_type(&self, key: &str) -> Option<DataType>

Returns the declared data type for key.

§Parameters

key - Metadata key to look up.

§Returns

Some declared data type for a known key; otherwise, None.

Source

pub fn unknown_metadata_field_policy(&self) -> UnknownMetadataFieldPolicy

Returns the policy for undeclared metadata fields.

§Returns

The policy applied to undeclared metadata keys.

Source

pub fn unknown_filter_field_policy(&self) -> UnknownFilterFieldPolicy

Returns the policy for undeclared filter fields.

§Returns

The policy applied to filter keys not declared in this schema.

Source

pub fn fields(&self) -> impl Iterator<Item = (&str, &MetadataField)>

Returns an iterator over schema fields in key-sorted order.

§Returns

An iterator yielding key and field-definition pairs.

Source

pub fn validate(&self, meta: &Metadata) -> MetadataValidationResult<()>

Validates a metadata object against this schema.

§Parameters

meta - Metadata object to validate.

§Returns

Ok(()) when every entry satisfies the schema.

§Errors

Returns an aggregate error containing every required-field, declared-type, and unknown-field issue discovered during this validation pass.

Source

pub fn validate_wire_contract(&self) -> MetadataResult<()>

Validates that this schema fits the strict V1 wire contract.

This preflight checks the same field-count and key-byte limits enforced by Serialize::serialize, allowing callers to reject invalid schemas before crossing a persistence or network boundary.