Struct NodeInfo 

pub struct NodeInfo {
    pub manufacturer: String,
    pub model: String,
    pub hardware_version: String,
    pub software_version: String,
    pub user_name: String,
    pub user_description: String,
}

Simple Node Information, reported to configuration tools such as JMRI.

The Simple Node Information Standard (SNIP) lets a tool ask any node for six human-readable strings without reading its configuration memory. The first four are fixed by the manufacturer; the last two are set by the user (JMRI shows them as the node’s name and description). Node answers SNIP requests from its NodeInfo automatically.

Wire format of the reply payload:

 0x04                        manufacturer section version
 manufacturer \0             max 41 bytes incl. NUL
 model \0                    max 41
 hardware_version \0         max 21
 software_version \0         max 21
 0x02                        user section version
 user_name \0                max 63
 user_description \0         max 64

use rolcb::NodeInfo;

let info = NodeInfo {
    manufacturer: "Uncommon Models".into(),
    model: "Dispatch Panel".into(),
    software_version: "0.1.0".into(),
    user_name: "Yard tower".into(),
    ..Default::default()
};
let bytes = info.snip_payload();
assert_eq!(bytes[0], 4);
assert_eq!(NodeInfo::from_snip(&bytes), info);

Fields

manufacturer: String

Manufacturer name (truncated to 40 bytes on the wire).

model: String

Model name (truncated to 40 bytes).

hardware_version: String

Hardware version (truncated to 20 bytes).

software_version: String

Software version (truncated to 20 bytes).

user_name: String

User-assigned node name (truncated to 62 bytes).

user_description: String

User-assigned description (truncated to 63 bytes).

Implementations

impl NodeInfo

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

Encode as a SNIP reply payload.

Over-long strings are truncated at a UTF-8 character boundary to fit the field limits shown in the type docs.

pub fn from_snip(p: &[u8]) -> NodeInfo

Decode a SNIP reply payload (lenient).

The two version bytes are skipped without checking, missing fields become empty strings and invalid UTF-8 is replaced with U+FFFD, so this never fails.

Trait Implementations

impl Clone for NodeInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeInfo

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

Formats the value using the given formatter.

impl Default for NodeInfo

fn default() -> Self

Returns the “default value” for a type.

impl Eq for NodeInfo

impl PartialEq for NodeInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NodeInfo