Struct FrameType 

pub struct FrameType(/* private fields */);

An MS/TP frame type: the first octet of the header after the preamble, which says what the frame is (Clause 9.3).

The set is open, so a decoder hands on every octet as it arrived and a dispatcher matches the constants with a _ arm for the rest. The constants are the ten types Clause 9.3 defines. Any other octet is reserved (8-31), reserved and COBS-encoded (34-127), or proprietary (128-255); FrameType::from_raw wraps it all the same, and two frame types are equal when their octets are.

Frame types are numbered in decimal, as Clause 9.3 numbers them: the constants’ wire values below, and Debug and Display for a type no constant names.

use bacnet_mstp_codec::FrameType;

assert_eq!(FrameType::from_raw(0), FrameType::TOKEN);
assert_eq!(FrameType::TOKEN.name(), Some("TOKEN"));

// A proprietary type has no name, but keeps its octet.
let proprietary = FrameType::from_raw(128);
assert!(proprietary.is_proprietary() && !proprietary.is_defined());
assert_eq!(proprietary.to_raw(), 128);
assert_eq!(format!("{proprietary:?}"), "FrameType(128)");
assert_eq!(format!("{:?}", FrameType::TOKEN), "FrameType::TOKEN");

Implementations

impl FrameType

pub const TOKEN: Self

Token: passes the right to send to the next master (Clause 9.3.1).

Wire value 0.

pub const POLL_FOR_MASTER: Self

Poll For Master: looks for a master at an address (Clause 9.3.2).

Wire value 1.

pub const REPLY_TO_POLL_FOR_MASTER: Self

Reply To Poll For Master: a master answering a poll (Clause 9.3.3).

Wire value 2.

pub const TEST_REQUEST: Self

Test_Request: asks the receiver to send its data back (Clause 9.3.4).

Wire value 3.

pub const TEST_RESPONSE: Self

Test_Response: the answer to a Test_Request (Clause 9.3.5).

Wire value 4.

pub const BACNET_DATA_EXPECTING_REPLY: Self

BACnet Data Expecting Reply: an NPDU whose sender waits for an answer (Clause 9.3.6).

Wire value 5.

pub const BACNET_DATA_NOT_EXPECTING_REPLY: Self

BACnet Data Not Expecting Reply: an NPDU that wants no answer (Clause 9.3.7).

Wire value 6.

pub const REPLY_POSTPONED: Self

Reply Postponed: puts off the answer to a BACnet Data Expecting Reply (Clause 9.3.8).

Wire value 7.

pub const BACNET_EXTENDED_DATA_EXPECTING_REPLY: Self

BACnet Extended Data Expecting Reply: an NPDU too long for a standard frame, COBS-encoded (Clause 9.3.9).

Wire value 32.

pub const BACNET_EXTENDED_DATA_NOT_EXPECTING_REPLY: Self

BACnet Extended Data Not Expecting Reply: an NPDU too long for a standard frame, COBS-encoded (Clause 9.3.10).

Wire value 33.

pub const ALL_NAMED: &[(&str, Self)]

Every named constant, with its name, in the order declared.

pub const fn from_raw(value: u8) -> Self

Wrap a raw wire value, named or not.

pub const fn to_raw(self) -> u8

The raw wire value.

pub const fn name(self) -> Option<&'static str>

The constant’s name, or None for a value the standard doesn’t define.

pub const fn is_defined(self) -> bool

Whether the standard defines this value.

impl FrameType

pub const fn allows_data(self) -> bool

Whether a frame of this type may carry a data field.

False only for the four types defined without data: TOKEN, POLL_FOR_MASTER, REPLY_TO_POLL_FOR_MASTER and REPLY_POSTPONED (Clauses 9.3.1-9.3.3, 9.3.8). Every other type may, including the reserved types 8-31, which the codec passes through without policing their content.

pub const fn is_cobs(self) -> bool

Whether this type is in the COBS-encoded range, 32-127 (Clause 9.3). Its Length must fall within MIN_COBS_LENGTH..=MAX_COBS_LENGTH (Clause 9.5.8).

pub const fn is_extended_data(self) -> bool

Whether this is one of the two extended data types, 32 and 33: the COBS-encoded types the codec encodes and decodes, which carry BACnet NPDUs of 502 to MAX_EXTENDED_MPDU_DATA octets (Clauses 9.3.9, 9.3.10). The rest of the COBS range, 34-127, is reserved.

pub const fn is_proprietary(self) -> bool

Whether this type is in the vendor-proprietary range, 128-255. Such a frame’s data opens with a 2-octet vendor identifier (Clause 9.3.11).

Trait Implementations

impl Clone for FrameType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameType

impl Debug for FrameType

Name::CONSTANT for a named value, Name(raw) otherwise.

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

Formats the value using the given formatter.

impl Display for FrameType

The constant’s name, or the raw value in decimal.

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

Formats the value using the given formatter.

impl Eq for FrameType

impl Hash for FrameType

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 FrameType

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameType