Skip to main content

NetworkMessageType

Struct NetworkMessageType 

Source
pub struct NetworkMessageType(/* private fields */);
Expand description

A network-layer message type: the octet after an NPDU’s addresses that says which message it carries (Clause 6.2.4).

The set is open, so Npdu::decode hands on every octet as it arrived, and a router matches the constants with a _ arm for the rest. The constants name the types a router reads and sends, grouped by what a router does with them and by name within a group, and ALL_NAMED lists them that way. Of the other octets, 0x80 and up are vendor proprietary (is_proprietary), 0x0A to 0x11 are the network-security types the standard no longer defines (is_removed_security), and the rest are reserved. Two message types are equal when their octets are.

use bacnet_npdu::NetworkMessageType;

assert_eq!(NetworkMessageType::from_raw(0x13), NetworkMessageType::NETWORK_NUMBER_IS);
assert_eq!(NetworkMessageType::NETWORK_NUMBER_IS.name(), Some("NETWORK_NUMBER_IS"));

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

Implementations§

Source§

impl NetworkMessageType

Source

pub const I_AM_ROUTER_TO_NETWORK: Self

A router’s list of what it reaches; this router learns from it.

Wire value 0x01.

Source

pub const I_COULD_BE_ROUTER_TO_NETWORK: Self

A route on offer; kept only where the table has none.

Wire value 0x02.

Source

pub const REJECT_MESSAGE_TO_NETWORK: Self

A refusal with its reason, carried back to whoever sent the message.

Wire value 0x03.

Source

pub const WHO_IS_ROUTER_TO_NETWORK: Self

A route query, answered here or searched for beyond.

Wire value 0x00.

Source

pub const ROUTER_AVAILABLE_TO_NETWORK: Self

Lifts a hold on traffic.

Wire value 0x05.

Source

pub const ROUTER_BUSY_TO_NETWORK: Self

Puts a hold on traffic, which lapses on its own.

Wire value 0x04.

Source

pub const INITIALIZE_ROUTING_TABLE: Self

A table update, or a query with a count of 0.

Wire value 0x06.

Source

pub const INITIALIZE_ROUTING_TABLE_ACK: Self

What comes back for one.

Wire value 0x07.

Source

pub const DISCONNECT_CONNECTION_TO_NETWORK: Self

Counted and otherwise ignored here.

Wire value 0x09.

Source

pub const ESTABLISH_CONNECTION_TO_NETWORK: Self

Logged and otherwise ignored here.

Wire value 0x08.

Source

pub const NETWORK_NUMBER_IS: Self

The number, and whether it was configured.

Wire value 0x13.

Source

pub const WHAT_IS_NETWORK_NUMBER: Self

The question that number answers.

Wire value 0x12.

Source

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

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

Source

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

Wrap a raw wire value, named or not.

Source

pub const fn to_raw(self) -> u8

The raw wire value.

Source

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

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

Source

pub const fn is_defined(self) -> bool

Whether the standard defines this value.

Source§

impl NetworkMessageType

Source

pub const fn is_proprietary(self) -> bool

Whether this is a vendor-proprietary type, 0x80 and up, which an NPDU follows with a two-octet vendor ID.

Source

pub const fn is_removed_security(self) -> bool

Whether this is one of the network-security types, 0x0A to 0x11, that the standard no longer defines. A router doesn’t reject them.

Trait Implementations§

Source§

impl Clone for NetworkMessageType

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 Copy for NetworkMessageType

Source§

impl Debug for NetworkMessageType

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for NetworkMessageType

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for NetworkMessageType

Source§

impl Hash for NetworkMessageType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for NetworkMessageType

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 NetworkMessageType

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, 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.