Struct commodity::CommodityTypeID

pub struct CommodityTypeID { /* fields omitted */ }

The id of a CommodityType stored in a fixed length array using ArrayString, with a maximum length of COMMODITY_TYPE_ID_LENGTH.

Implementations

impl CommodityTypeID

pub fn new(id_array: ArrayString<[u8; 8]>) -> CommodityTypeID

Create a new CommodityTypeID.

Trait Implementations

impl Clone for CommodityTypeID

fn clone(&self) -> CommodityTypeID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CommodityTypeID

impl Debug for CommodityTypeID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommodityTypeID

fn deserialize<D>(deserializer: D) -> Result<CommodityTypeID, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for CommodityTypeID

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

Formats the value using the given formatter.

impl Eq for CommodityTypeID

impl<'_> From<&'_ CommodityType> for CommodityTypeID

fn from(commodity_type: &CommodityType) -> CommodityTypeID

Performs the conversion.

impl FromStr for CommodityTypeID

type Err = CommodityError

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<CommodityTypeID, CommodityError>

Create a new CommodityType.

code is an array backed string that has a fixed maximum size of COMMODITY_TYPE_ID_LENGTH. The supplied string must not exeed this, or a CommodityError::TooLongCommodityTypeID will be returned.

Example

use std::str::FromStr;
let commodity_id = CommodityTypeID::from_str("AUD").unwrap();
assert_eq!("AUD", commodity_id);

impl Hash for CommodityTypeID

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for CommodityTypeID

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<CommodityTypeID> for CommodityTypeID

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

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

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

This method tests for !=.

impl<'_> PartialEq<CommodityTypeID> for &'_ str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<CommodityTypeID> for CommodityTypeID

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

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

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

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

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

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

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

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

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

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

impl Serialize for CommodityTypeID

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for CommodityTypeID

impl StructuralPartialEq for CommodityTypeID