Struct claude::Currency

pub struct Currency {
    pub symbol: Option<Symbol>,
    pub value: i64,
}

Represents currency through an optional symbol and amount of coin.

Each 100 coins results in a banknote. (100 is formatted as 1.00) The currency will be formatted as such: Currency(Some('$'), 432) ==> “$4.32”

Fields

symbol: Option<Symbol>

Currency symbol

pick any of €, £, $, ¥ etc…

value: i64

value in the smallest possible unit

Implementations

impl Currency

pub fn new() -> Currency

Creates a blank Currency as Currency(None, 0)

Examples

let mut c = Currency::new();

pub fn from_value(value: i64) -> Currency

Initialize from i64

pub fn postfix(&self) -> Postfix<'_>

Returns an object that implements Display for different methods of printing currency.

pub fn prefix(&self) -> Prefix<'_>

Returns an object that implements Display for different methods of printing currency.

pub fn as_float(&self) -> f64

Returns the value as float

Warning, do not use this for calculation, this is for displaying only!

pub fn value(&self) -> i64

Returns the inner value

pub fn symbol(&self) -> Option<Symbol>

Returns the inner symbol

Methods from Deref<Target = i64>

pub const MIN: i64

pub const MAX: i64

pub const BITS: u32

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

🔬 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 = 0x1234567890123456i64;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]
    } else {
        &[0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

Trait Implementations

impl Add<Currency> for Currency

Overloads the ‘+’ operator for Currency objects.

Panics

Panics if the two addends are different types of currency, as denoted by the Currency’s symbol.

type Output = Currency

The resulting type after applying the + operator.

fn add(self, rhs: Currency) -> Currency

Performs the + operation.

impl Clone for Currency

fn clone(&self) -> Currency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Currency

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

Formats the value using the given formatter.

impl Default for Currency

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Currency

Required for DerefMut

type Target = i64

The resulting type after dereferencing.

fn deref(&self) -> &i64

Dereferences the value.

impl Div<i64> for Currency

Overloads the ‘/’ operator for Currency objects.

Allows a Currency to be divided by an i64.

type Output = Currency

The resulting type after applying the / operator.

fn div(self, rhs: i64) -> Currency

Performs the / operation.

impl From<(char, i64)> for Currency

fn from(tpl: (Symbol, i64)) -> Currency

converts from a tuple of symbol and i64

impl From<(i64, char)> for Currency

fn from(tpl: (i64, Symbol)) -> Currency

converts from a tuple of i64 and symbol

impl From<i64> for Currency

fn from(value: i64) -> Currency

converts from a i64

impl Mul<Currency> for i64

Overloads the ‘*’ operator for i64.

Allows an i64 to be multiplied by a Currency. Completes the commutative property for i64 multiplied by Currency.

type Output = Currency

The resulting type after applying the * operator.

fn mul(self, rhs: Currency) -> Currency

Performs the * operation.

impl Mul<f64> for Currency

Multiplies with float, probably not a good idea, help appreciated.

type Output = Currency

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Currency

Performs the * operation.

impl Mul<i64> for Currency

Overloads the ‘*’ operator for Currency objects.

Allows a Currency to be multiplied by an i64.

type Output = Currency

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Currency

Performs the * operation.

impl PartialEq<Currency> for Currency

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

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

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

This method tests for !=.

impl PartialOrd<Currency> for Currency

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

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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 Sub<Currency> for Currency

Overloads the ‘-’ operator for Currency objects.

Panics

Panics if the minuend and subtrahend are two different types of currency, as denoted by the Currency’s symbol.

type Output = Currency

The resulting type after applying the - operator.

fn sub(self, rhs: Currency) -> Currency

Performs the - operation.

impl Copy for Currency

impl Eq for Currency

impl StructuralEq for Currency

impl StructuralPartialEq for Currency