Struct Schema

pub struct Schema {
    pub package: Option<String>,
    pub id: Option<i32>,
    pub version: u32,
    pub semantic_version: Option<SematicVersion>,
    pub description: Option<String>,
    pub byte_order: Option<ByteOrder>,
    pub include: Option<Vec<Include>>,
    pub types: Option<Vec<Types>>,
    pub messages: Option<Vec<Message>>,
    pub header_type: Option<String>,
}

Structure that represent top level SBE schema.

Fields

package: Option<String>

The package name of the schema.

id: Option<i32>

The id of the schema.

version: u32

The version of the schema.

semantic_version: Option<SematicVersion>

The semantic version of the schema.

description: Option<String>

The description of the schema.

byte_order: Option<ByteOrder>

The byte order of the bytes. default to littleEndian but we need to know if it was set or not therefore use of Option

include: Option<Vec<Include>>

The include section of the schema.

types: Option<Vec<Types>>

The types of the schema.

messages: Option<Vec<Message>>

The messages of the schema.

header_type: Option<String>

header type name default to “messageHeader” but we need to know if it was set or not therefore use of Option

Implementations

impl Schema

pub fn message_header(&self) -> Option<&Composite>

Get the message header composite type.

Trait Implementations

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Schema

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Schema

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PathBuf> for Schema

type Error = SbeSchemaError

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Schema