Struct Mti 

pub struct Mti(pub u16);

A 16-bit OpenLCB Message Type Indicator.

The associated constants name every MTI the crate decodes into a dedicated Message variant. Other values can still be built with Mti(0x…) and are carried by Message::Other.

Tuple Fields

0: u16

Implementations

impl Mti

pub const INITIALIZATION_COMPLETE: Mti

Initialization Complete (global). Sent once by a node after it has finished logging in; carries the 6-byte Node ID.

pub const INITIALIZATION_COMPLETE_SIMPLE: Mti

Initialization Complete from a node that implements only the Simple Protocol subset.

pub const VERIFY_NODE_ID_ADDRESSED: Mti

Verify Node ID, addressed to one node. Optional Node ID payload.

pub const VERIFY_NODE_ID_GLOBAL: Mti

Verify Node ID, global: “everyone (or the node with this ID) please announce yourself”. Optional Node ID payload.

pub const VERIFIED_NODE_ID: Mti

Verified Node ID (global): the answer to Verify Node ID, carrying the responder’s Node ID.

pub const VERIFIED_NODE_ID_SIMPLE: Mti

Verified Node ID from a Simple Protocol node.

pub const OPTIONAL_INTERACTION_REJECTED: Mti

Optional Interaction Rejected (addressed): the receiver does not support or cannot handle the request. Payload is an error code (see error_code) and the MTI being rejected.

pub const TERMINATE_DUE_TO_ERROR: Mti

Terminate Due To Error (addressed): an interaction was aborted. Payload is an error code and the related MTI.

pub const PROTOCOL_SUPPORT_INQUIRY: Mti

Protocol Support Inquiry (addressed): “which protocols do you speak?”

pub const PROTOCOL_SUPPORT_REPLY: Mti

Protocol Support Reply (addressed): a bit field of supported protocols, see crate::message::protocol.

pub const IDENTIFY_CONSUMER: Mti

Identify Consumer (global, with event): “who consumes this event?”

pub const CONSUMER_RANGE_IDENTIFIED: Mti

Consumer Range Identified: the sender consumes a whole range of events, encoded as a mask in the low-order bits of the Event ID.

pub const CONSUMER_IDENTIFIED_VALID: Mti

Consumer Identified, state Valid.

pub const CONSUMER_IDENTIFIED_INVALID: Mti

Consumer Identified, state Invalid.

pub const CONSUMER_IDENTIFIED_UNKNOWN: Mti

Consumer Identified, state Unknown.

pub const IDENTIFY_PRODUCER: Mti

Identify Producer (global, with event): “who produces this event?” Also used by the Train Search Standard (see traction::search).

pub const PRODUCER_RANGE_IDENTIFIED: Mti

Producer Range Identified: the sender produces a range of events.

pub const PRODUCER_IDENTIFIED_VALID: Mti

Producer Identified, state Valid.

pub const PRODUCER_IDENTIFIED_INVALID: Mti

Producer Identified, state Invalid.

pub const PRODUCER_IDENTIFIED_UNKNOWN: Mti

Producer Identified, state Unknown.

pub const IDENTIFY_EVENTS_ADDRESSED: Mti

Identify Events (addressed): “tell me everything you produce and consume”.

pub const IDENTIFY_EVENTS_GLOBAL: Mti

Identify Events (global): every node lists all its events.

pub const LEARN_EVENT: Mti

Learn Event: teaching message used by blue/gold button configuration.

pub const PCER: Mti

Producer/Consumer Event Report: “this event just happened”.

pub const TRACTION_CONTROL_COMMAND: Mti

Traction Control Command (addressed, throttle → train), defined by the Traction Control Standard. See crate::traction::Command.

pub const TRACTION_CONTROL_REPLY: Mti

Traction Control Reply (addressed, train → throttle). See crate::traction::Reply.

pub const SNIP_REQUEST: Mti

Simple Node Information Request (addressed), from the Simple Node Information Standard.

pub const SNIP_REPLY: Mti

Simple Node Information Reply (addressed, multi-frame). Payload format in NodeInfo::snip_payload.

pub const DATAGRAM: Mti

Datagram (addressed, up to 72 bytes), from the Datagram Transport Standard. On CAN it uses datagram frame types instead of a CAN-MTI.

pub const DATAGRAM_RECEIVED_OK: Mti

Datagram Received OK (addressed). Optional one-byte flags field.

pub const DATAGRAM_REJECTED: Mti

Datagram Rejected (addressed), with an error_code.

pub const fn is_addressed(self) -> bool

True if the message carries a destination (addressed message).

This is bit 3 (0x0008) of the MTI. On CAN, addressed messages put the 12-bit destination alias in the first two data bytes; see Message::to_frames.

pub const fn has_event(self) -> bool

True if the message carries an Event ID (bit 2, 0x0004).

pub const fn can_mti(self) -> u16

The 12-bit value carried in the CAN header for this MTI.

This is simply the low 12 bits. It is only meaningful for MTIs sent in global/addressed frames (frame type 1); Mti::DATAGRAM uses datagram frame types instead. MTIs with bit 12 set do not fit; see Message::try_to_frames.

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

A short human readable name, for logging ("Unknown" for MTIs without a constant). Display prints the name and the hex value.

pub const fn from_can_mti(v: u16) -> Mti

Map a 12-bit CAN-MTI back to the full MTI. All MTIs that are sent in CAN “global/addressed” frames fit in 12 bits, so this is the identity.

Trait Implementations

impl Clone for Mti

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 Mti

impl Debug for Mti

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

Formats the value using the given formatter.

impl Display for Mti

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

PCER (0x05B4), or Unknown (0x0DA8) for MTIs without a constant.

assert_eq!(rolcb::Mti::PCER.to_string(), "PCER (0x05B4)");

impl Eq for Mti

impl Hash for Mti

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 Ord for Mti

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Mti

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Mti

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Mti