Struct FieldEntry

pub struct FieldEntry { /* private fields */ }

Field entry definition for Anda DB

Contains field name, type, constraints, and index information Field names are renamed in serialization to save storage space

Implementations

impl FieldEntry

pub fn new(name: String, type: FieldType) -> Result<FieldEntry, SchemaError>

Create a new field entry

Arguments

• name - Field name
• r#type - Field type

Returns

• Result<Self, SchemaError> - The created field entry or an error message

pub fn with_description(self, description: String) -> FieldEntry

Set the field description

Arguments

• description - Field description

Returns

• Self - The modified field entry

pub fn with_unique(self) -> FieldEntry

Mark the field as unique

Returns

• Self - The modified field entry

pub fn with_idx(self, idx: usize) -> FieldEntry

Set the field index

Arguments

• idx - Field index value

Returns

• Self - The modified field entry

pub fn name(&self) -> &str

Get the field name

Returns

• &str - The field name

pub fn type(&self) -> &FieldType

Get the field type

Returns

• &FieldType - The field type

pub fn required(&self) -> bool

pub fn unique(&self) -> bool

Check if the field is unique

Returns

• bool - True if the field is unique

pub fn idx(&self) -> usize

Get the field index

Returns

• usize - The field index

pub fn extract( &self, val: Value, validate: bool, ) -> Result<FieldValue, SchemaError>

Extract a field value from a CBOR value

Arguments

• val - The CBOR value to extract from
• validate - Whether to validate the extracted value

Returns

• Result<FieldValue, SchemaError> - The extracted field value or an error message

pub fn validate(&self, value: &FieldValue) -> Result<(), SchemaError>

Validate a field value against this field entry’s constraints

Arguments

• value - The field value to validate

Returns

• Result<(), SchemaError> - Ok if valid, or an error message if invalid

Trait Implementations

impl Clone for FieldEntry

fn clone(&self) -> FieldEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldEntry

fn deserialize<__D>( __deserializer: __D, ) -> Result<FieldEntry, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldEntry

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldEntry