Struct ads::AmsNetId

pub struct AmsNetId(pub [u8; 6]);

Represents an AMS NetID.

The NetID consists of 6 bytes commonly written like an IPv4 address, i.e. 1.2.3.4.5.6. Together with an AMS port (16-bit integer), it uniquely identifies an endpoint of an ADS system that can be communicated with.

Although often the first 4 bytes of a NetID look like an IP address, and sometimes even are identical to the device's IP address, there is no requirement for this, and one should never rely on it.

Methods

impl AmsNetId

pub fn new(a: u8, b: u8, c: u8, d: u8, e: u8, f: u8) -> Self

Create a NetID from six bytes.

pub fn from_slice(slice: &[u8]) -> Self

Create a NetID from a slice (which must have length 6).

pub fn is_zero(&self) -> bool

Check if the NetID is all-zero.

Trait Implementations

impl Clone for AmsNetId

fn clone(&self) -> AmsNetId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AmsNetId

impl PartialEq for AmsNetId

fn eq(&self, __arg_0: &AmsNetId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &AmsNetId) -> bool

This method tests for !=.

impl Eq for AmsNetId

impl PartialOrd for AmsNetId

fn partial_cmp(&self, __arg_0: &AmsNetId) -> Option<Ordering>

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

fn lt(&self, __arg_0: &AmsNetId) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &AmsNetId) -> bool

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

fn gt(&self, __arg_0: &AmsNetId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &AmsNetId) -> bool

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

impl Ord for AmsNetId

fn cmp(&self, __arg_0: &AmsNetId) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Default for AmsNetId

fn default() -> AmsNetId

Returns the "default value" for a type.

impl FromStr for AmsNetId

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AmsNetId, &'static str>

Parse a NetID from a string (a.b.c.d.e.f).

Bytes can be missing in the end; missing bytes are substituted by 1.

impl Display for AmsNetId

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

Format a NetID in the usual format.