Skip to main content

MessageDef

Struct MessageDef 

Source
#[non_exhaustive]
pub struct MessageDef { pub name: String, pub endian: Endian, pub bits: Option<BitOrder>, pub needs: Vec<Param>, pub segments: Vec<Segment>, pub doc: Option<String>, pub derives: Vec<Derive>, pub lifetime: Option<String>, }
Expand description

A variable-length message.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The type name.

§endian: Endian

The byte order.

§bits: Option<BitOrder>

The bit order, or None for a byte-addressed message.

A bit-addressed message holds bit fields and inline presence bits, padded with zeros to a whole byte.

§needs: Vec<Param>

The parameters, which generate a <Name>Ctx struct used as Message::Ctx.

§segments: Vec<Segment>

The segments, in wire order.

§doc: Option<String>

Documentation.

§derives: Vec<Derive>

Derives for this message, written after the module’s.

§lifetime: Option<String>

The lifetime of borrowed fields, without the ': Some("a") declares Name<'a>.

The message implements layline::MessageRef<'a> instead of layline::Message, so it takes no needs and no other message can hold it.

Implementations§

Source§

impl MessageDef

Source

pub fn new(name: &str, segments: Vec<Segment>) -> Self

A little-endian, byte-addressed message.

Source

pub fn with_lifetime(self, lifetime: &str) -> Self

Declares Name<'lifetime>, whose borrowed fields hold views of the input.

Source

pub fn with_doc(self, doc: &str) -> Self

Sets the documentation.

Source

pub fn with_derives(self, derives: Vec<Derive>) -> Self

Sets the derives written on this message, after the module’s.

Source

pub fn with_needs(self, needs: Vec<Param>) -> Self

Sets the parameters.

Source

pub fn with_endian(self, endian: Endian) -> Self

Sets the byte order.

Source

pub fn with_bits(self, order: BitOrder) -> Self

Makes the message bit-addressed, in this bit order.

Trait Implementations§

Source§

impl Clone for MessageDef

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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
Source§

impl Eq for MessageDef

Source§

impl PartialEq for MessageDef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MessageDef

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.