Struct x328_proto::Parameter

#[repr(transparent)]
pub struct Parameter(_);

Parameter is a range-checked [0, 9999] integer, representing a register in a node.

Implementations

impl Parameter

pub fn new(parameter: impl TryInto<i16>) -> Result<Self, Error>

Create a new Parameter, checking that the given value is in the range [0, 9999].

Errors

Returns Error::InvalidParameter if parameter is out of range.

Methods from Deref<Target = i16>

pub const MIN: i16

pub const MAX: i16

pub const BITS: u32

pub fn as_ne_bytes(&self) -> &[u8; 2]

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

Return the memory representation of this integer as a byte array in native byte order.

to_ne_bytes should be preferred over this whenever possible.

Examples

#![feature(num_as_ne_bytes)]
let num = 0x1234i16;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x12, 0x34]
    } else {
        &[0x34, 0x12]
    }
);

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Parameter

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Deref for Parameter

type Target = i16

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for Parameter

impl FromStr for Parameter

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

This is meant to be used for parsing the on-wire format

impl Hash for Parameter

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IntoParameter for Parameter

fn into_parameter(self) -> Result<Parameter, Error>

Convert self to Parameter.

impl Ord for Parameter

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Parameter> for Parameter

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

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

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

This method tests for !=.

impl PartialEq<usize> for Parameter

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Parameter> for Parameter

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl StructuralEq for Parameter

impl StructuralPartialEq for Parameter

impl TryFrom<&'_ [u8]> for Parameter

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Parameter

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.