Enum Frame 

pub enum Frame {
    Ack(AckFrame),
    Nack(NackFrame),
    Short(ShortFrame),
    Control(ControlFrame),
    Long(LongFrame),
}

Any supported wired M-Bus frame.

The long variant remains inline so this type works without an allocator.

Variants

Ack(AckFrame)

A positive acknowledgement.

Nack(NackFrame)

A negative acknowledgement.

Short(ShortFrame)

A fixed-length short frame.

Control(ControlFrame)

A variable-format frame without user data.

Long(LongFrame)

A variable-format frame with user data.

Implementations

impl Frame

pub const fn kind(&self) -> FrameKind

Returns the frame’s wire format.

pub fn len(&self) -> usize

Returns the encoded frame length.

pub const fn is_empty(&self) -> bool

Returns whether the encoded frame is empty.

pub fn encode_into<'a>( &self, output: &'a mut [u8], ) -> Result<&'a [u8], FrameEncodeError>

Encodes the frame into output and returns the encoded portion.

Errors

Returns FrameEncodeError when output is shorter than Self::len.

Examples found in repository

examples/decode_exact_no_alloc.rs (line 31)

fn main() -> Result<(), DecodeError> {
    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;

    if let Frame::Short(short) = &frame {
        assert_eq!(
            short.control().communication_type(),
            CommunicationType::ReqUd2
        );
        assert_eq!(short.address().value(), 1);
    }

    let mut output = [0_u8; LongFrame::MAX_LEN];
    assert_eq!(
        frame
            .encode_into(&mut output)
            .expect("maximum frame buffer is large enough"),
        [0x10, 0x5b, 0x01, 0x5c, 0x16]
    );

    Ok(())
}

pub fn encode(&self) -> Vec<u8>

Encodes the frame into a newly allocated vector.

Examples found in repository

examples/decode_exact_alloc.rs (line 28)

fn main() -> Result<(), DecodeError> {
    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;

    if let Frame::Short(short) = &frame {
        assert_eq!(
            short.control().communication_type(),
            CommunicationType::ReqUd2
        );
        assert_eq!(short.address().value(), 1);
    }

    assert_eq!(frame.encode(), [0x10, 0x5b, 0x01, 0x5c, 0x16]);
    Ok(())
}

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Eq for Frame

impl From<AckFrame> for Frame

fn from(frame: AckFrame) -> Self

Converts to this type from the input type.

impl From<ControlFrame> for Frame

fn from(frame: ControlFrame) -> Self

Converts to this type from the input type.

impl From<LongFrame> for Frame

fn from(frame: LongFrame) -> Self

Converts to this type from the input type.

impl From<NackFrame> for Frame

fn from(frame: NackFrame) -> Self

Converts to this type from the input type.

impl From<ShortFrame> for Frame

fn from(frame: ShortFrame) -> Self

Converts to this type from the input type.

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame