Schema

Struct Schema 

Source
pub struct Schema {
    pub name: String,
    pub fields: Vec<SchemaField>,
    pub key_field_index: Option<usize>,
    pub is_validated: bool,
}
Expand description

Represents a schema for a DBC file

Fields§

§name: String

Name of the schema

§fields: Vec<SchemaField>

Fields in the schema

§key_field_index: Option<usize>

Index of the key field, if any

§is_validated: bool

Whether the schema is validated

Implementations§

Source§

impl Schema

Source

pub fn new(name: impl Into<String>) -> Self

Create a new schema

Source

pub fn add_field(&mut self, field: SchemaField) -> &mut Self

Add a field to the schema

Source

pub fn set_key_field_index(&mut self, index: usize) -> &mut Self

Set the key field by index

Source

pub fn set_key_field(&mut self, name: &str) -> &mut Self

Set the key field by name

§Panics

Panics if the field with the given name is not found in the schema. This is intentional as it indicates a programming error in schema definition.

Source

pub fn try_set_key_field(&mut self, name: &str) -> Result<&mut Self, String>

Try to set the key field by name, returning an error if the field is not found

Source

pub fn record_size(&self) -> usize

Calculate the total size of a record in bytes

Source

pub fn validate( &mut self, field_count: u32, record_size: u32, ) -> Result<(), String>

Validate the schema against a DBC header

Trait Implementations§

Source§

impl Clone for Schema

Source§

fn clone(&self) -> Schema

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Schema

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Schema

§

impl RefUnwindSafe for Schema

§

impl Send for Schema

§

impl Sync for Schema

§

impl Unpin for Schema

§

impl UnwindSafe for Schema

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.