Struct jcm::Denomination

#[repr(C)]
pub struct Denomination(/* private fields */);

Represents the currency denomination.

Format

Field	Integer	Exponent
Length	1 byte	1 byte

Denominations representable by a u8 will have a zero exponent, e.g. 100 = 100 * 10^0.

Any denomination above u8::MAX will have a non-zero exponent, e.g. 500 = 50 * 10^1.

Implementations

impl Denomination

pub const fn new() -> Self

Creates a new Denomination.

pub const fn integer(&self) -> u8

Gets the integer field of the Denomination.

pub const fn exponent(&self) -> u8

Gets the exponent field of the Denomination.

pub fn value(&self) -> u64

Gets the value of the Denomination.

Example

use jcm::Denomination;

let denom = Denomination::new();
assert_eq!(denom.integer(), 1);
assert_eq!(denom.exponent(), 0);
assert_eq!(denom.value(), 1);

let denom = Denomination::from_value(500);
assert_eq!(denom.integer(), 50);
assert_eq!(denom.exponent(), 1);
assert_eq!(denom.value(), 500);

pub fn from_value(val: u64) -> Self

Infallible function that converts a value into a Denomination.

Example

use jcm::Denomination;

let denom = Denomination::from_value(2000);
assert_eq!(denom.integer(), 200);
assert_eq!(denom.exponent(), 1);
assert_eq!(denom.value(), 2000);

pub const fn len() -> usize

Gets the length of the Denomination.

pub const fn is_empty(&self) -> bool

Gets whether the Denomination is empty.

pub const fn is_valid(&self) -> bool

Gets whether the Denomination is valid.

pub const fn to_u16(&self) -> u16

Converts the Denomination to a u16.

pub const fn into_u16(self) -> u16

Converts the Denomination to a u16.

pub fn from_bytes(val: &[u8]) -> Self

Infallible function to convert a byte buffer into a Denomination.

pub fn valid_value(val: u64) -> bool

Gets whether the value is a valid Denomination.

pub fn to_bytes(&self, buf: &mut [u8]) -> Result<()>

Writes the Denomination to a byte buffer.

Trait Implementations

impl Clone for Denomination

fn clone(&self) -> Denomination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Denomination

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

Formats the value using the given formatter.

impl Default for Denomination

fn default() -> Self

Returns the “default value” for a type.

impl Display for Denomination

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

Formats the value using the given formatter.

impl PartialEq for Denomination

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &[u8]) -> Result<Self>

Performs the conversion.

impl<const N: usize> TryFrom<&[u8; N]> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &[u8; N]) -> Result<Self>

Performs the conversion.

impl<const N: usize> TryFrom<[u8; N]> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: [u8; N]) -> Result<Self>

Performs the conversion.

impl TryFrom<u16> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: u16) -> Result<Self>

Performs the conversion.

impl TryFrom<u32> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<Self>

Performs the conversion.

impl TryFrom<u64> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: u64) -> Result<Self>

Performs the conversion.

impl TryFrom<u8> for Denomination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: u8) -> Result<Self>

Performs the conversion.

impl Copy for Denomination

impl Eq for Denomination

impl StructuralPartialEq for Denomination