Struct MetadataField 

pub struct MetadataField { /* private fields */ }

Definition of one metadata field in a crate::MetadataSchema.

Its V1 wire representation is an object with exactly the data_type and required fields. Positional arrays are rejected by deserialization.

Examples

use qubit_datatype::DataType;
use qubit_metadata::MetadataField;

let field = MetadataField::new(DataType::String, true);
assert!(field.is_required());

Implementations

impl MetadataField

pub fn new(data_type: DataType, required: bool) -> Self

Creates a field definition.

Parameters

• data_type - Concrete data type accepted by the field.
• required - Whether metadata must provide a concrete value.

Returns

A new field definition.

pub fn data_type(&self) -> DataType

Returns the runtime data type of this field.

Returns

The declared field data type.

pub fn is_required(&self) -> bool

Returns true when this field is required.

Returns

true when validation requires a concrete value for this field.

Trait Implementations

impl Clone for MetadataField

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataField

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserializes a field definition from its strict object representation.

Type Parameters

• D - Deserializer providing the field object.

Parameters

• deserializer - Source of the serialized field definition.

impl Eq for MetadataField

impl PartialEq for MetadataField

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for MetadataField

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetadataField