Skip to main content

MessageDef

Struct MessageDef 

Source
pub struct MessageDef {
    pub name: String,
    pub id: u16,
    pub block_length: u16,
    pub semantic_type: Option<String>,
    pub description: Option<String>,
    pub since_version: Option<u16>,
    pub deprecated: Option<u16>,
    pub fields: Vec<FieldDef>,
    pub groups: Vec<GroupDef>,
    pub data_fields: Vec<DataFieldDef>,
}
Expand description

Message definition.

Fields§

§name: String

Message name.

§id: u16

Message template ID.

§block_length: u16

Block length (fixed portion size in bytes).

§semantic_type: Option<String>

Semantic type.

§description: Option<String>

Description.

§since_version: Option<u16>

Since version.

§deprecated: Option<u16>

Deprecated since version.

§fields: Vec<FieldDef>

Fixed fields in the root block.

§groups: Vec<GroupDef>

Repeating groups.

§data_fields: Vec<DataFieldDef>

Variable-length data fields.

Implementations§

Source§

impl MessageDef

Source

pub fn new(name: String, id: u16, block_length: u16) -> Self

Creates a new message definition.

Source

pub fn add_field(&mut self, field: FieldDef)

Adds a field to the message.

Source

pub fn add_group(&mut self, group: GroupDef)

Adds a group to the message.

Source

pub fn add_data_field(&mut self, data_field: DataFieldDef)

Adds a data field to the message.

Source

pub fn has_groups(&self) -> bool

Returns true if the message has any repeating groups.

Source

pub fn has_var_data(&self) -> bool

Returns true if the message has any variable-length data.

Source

pub fn min_encoded_length(&self) -> usize

Calculates the minimum encoded length (header + block).

Trait Implementations§

Source§

impl Clone for MessageDef

Source§

fn clone(&self) -> MessageDef

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 MessageDef

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.