Struct ShortFrame

Source

pub struct ShortFrame { /* private fields */ }

Expand description

A fixed-length short frame.

Implementations§

Source §

impl ShortFrame

Source

pub const START: u8 = 0x10

Initial frame byte.

Source

pub const STOP: u8 = 0x16

Final frame byte.

Source

pub const LEN: usize = 5

Encoded frame length.

Source

pub const fn new( control: Control, address: Address, ) -> Result<Self, ShortFrameError>

Creates a validated short frame.

Examples found in repository ?

examples/request_data_alloc.rs (line 15)

14fn main() -> Result<(), ShortFrameError> {
15    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;
16    let encoded = request.encode();
17
18    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
19    Ok(())
20}

More examples

Hide additional examples

examples/request_data_no_alloc.rs (line 15)

14fn main() -> Result<(), ShortFrameError> {
15    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;
16
17    let mut output = [0_u8; ShortFrame::LEN];
18    let encoded = request.encode_into(&mut output)?;
19
20    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
21    Ok(())
22}

Source

pub const fn control(&self) -> Control

Returns the control field.

Examples found in repository ?

examples/decode_exact_alloc.rs (line 22)

17fn main() -> Result<(), DecodeError> {
18    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;
19
20    if let Frame::Short(short) = &frame {
21        assert_eq!(
22            short.control().communication_type(),
23            CommunicationType::ReqUd2
24        );
25        assert_eq!(short.address().value(), 1);
26    }
27
28    assert_eq!(frame.encode(), [0x10, 0x5b, 0x01, 0x5c, 0x16]);
29    Ok(())
30}

More examples

Hide additional examples

examples/decode_exact_no_alloc.rs (line 22)

17fn main() -> Result<(), DecodeError> {
18    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;
19
20    if let Frame::Short(short) = &frame {
21        assert_eq!(
22            short.control().communication_type(),
23            CommunicationType::ReqUd2
24        );
25        assert_eq!(short.address().value(), 1);
26    }
27
28    let mut output = [0_u8; LongFrame::MAX_LEN];
29    assert_eq!(
30        frame
31            .encode_into(&mut output)
32            .expect("maximum frame buffer is large enough"),
33        [0x10, 0x5b, 0x01, 0x5c, 0x16]
34    );
35
36    Ok(())
37}

Source

pub const fn address(&self) -> Address

Returns the address field.

Examples found in repository ?

examples/decode_exact_alloc.rs (line 25)

17fn main() -> Result<(), DecodeError> {
18    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;
19
20    if let Frame::Short(short) = &frame {
21        assert_eq!(
22            short.control().communication_type(),
23            CommunicationType::ReqUd2
24        );
25        assert_eq!(short.address().value(), 1);
26    }
27
28    assert_eq!(frame.encode(), [0x10, 0x5b, 0x01, 0x5c, 0x16]);
29    Ok(())
30}

More examples

Hide additional examples

examples/decode_exact_no_alloc.rs (line 25)

17fn main() -> Result<(), DecodeError> {
18    let frame = decode(&[0x10, 0x5b, 0x01, 0x5c, 0x16])?;
19
20    if let Frame::Short(short) = &frame {
21        assert_eq!(
22            short.control().communication_type(),
23            CommunicationType::ReqUd2
24        );
25        assert_eq!(short.address().value(), 1);
26    }
27
28    let mut output = [0_u8; LongFrame::MAX_LEN];
29    assert_eq!(
30        frame
31            .encode_into(&mut output)
32            .expect("maximum frame buffer is large enough"),
33        [0x10, 0x5b, 0x01, 0x5c, 0x16]
34    );
35
36    Ok(())
37}

Source

pub fn decode(bytes: &[u8]) -> Result<Self, ShortFrameError>

Decodes exactly one short frame.

Source

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

Encodes the frame into output and returns the encoded portion.

Examples found in repository ?

examples/request_data_no_alloc.rs (line 18)

14fn main() -> Result<(), ShortFrameError> {
15    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;
16
17    let mut output = [0_u8; ShortFrame::LEN];
18    let encoded = request.encode_into(&mut output)?;
19
20    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
21    Ok(())
22}

Source

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

Encodes the frame into a newly allocated vector.

Examples found in repository ?

examples/request_data_alloc.rs (line 16)

14fn main() -> Result<(), ShortFrameError> {
15    let request = ShortFrame::new(Control::req_ud2(false), Address::new(1))?;
16    let encoded = request.encode();
17
18    assert_eq!(encoded, [0x10, 0x5b, 0x01, 0x5c, 0x16]);
19    Ok(())
20}