Struct MetadataSchema 

pub struct MetadataSchema { /* private fields */ }

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.

Implementations

impl MetadataSchema

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

Validates a metadata filter against 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 UnknownFieldPolicy is UnknownFieldPolicy::Allow.

impl MetadataSchema

pub fn builder() -> MetadataSchemaBuilder

Creates a schema builder.

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

Returns the field definition for key.

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

Returns the declared data type for key.

pub fn unknown_field_policy(&self) -> UnknownFieldPolicy

Returns the unknown-field policy.

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

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

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

Validates a metadata object against this schema.

Errors

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

Trait Implementations

impl Clone for MetadataSchema

fn clone(&self) -> MetadataSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataSchema

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

Formats the value using the given formatter.

impl Default for MetadataSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetadataSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetadataSchema

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MetadataSchema

impl StructuralPartialEq for MetadataSchema