Struct polyvalue::types::Currency

pub struct Currency(/* private fields */);

Subtype of Value that represents a currency This is a wrapper around Fixed that adds a currency symbol

Implementations

impl Currency

pub fn from_fixed(value: Fixed) -> Self

Create a new Currency from a Fixed

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

Resolve the precision of this Currency with another Currency

impl Currency

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

Get the symbol of this Currency

pub fn precision(&self) -> i8

Get the precision of this Currency

pub fn value(&self) -> &Fixed

Get the value of this Currency

Trait Implementations

impl Add for Currency

type Output = Result<Currency, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl ArithmeticOperationExt for Currency

fn arithmetic_op( self, right: Self, operation: ArithmeticOperation ) -> Result<Self, Error>

Perform an arithmetic operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn arithmetic_neg(self) -> Result<Self, Error>

where Self: Sized,

Perform an arithmetic negation on a value This is equivalent to arithmetic_op with ArithmeticOperation::Negate but is provided for convenience

impl BooleanOperationExt for Currency

fn boolean_op( self, right: Self, operation: BooleanOperation ) -> Result<Value, Error>

Perform a boolean operation on two values If the operation is not supported on the given type, an Error::UnsupportedOperation will be returned

fn boolean_not(self) -> Result<Value, Error>

where Self: Sized,

Perform a boolean not on a value This is equivalent to boolean_op with BooleanOperation::Not but is provided for convenience

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() -> Currency

Returns the “default value” for a type.

impl DerefMut for Currency

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Currency

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Currency

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

Formats the value using the given formatter.

impl Div for Currency

type Output = Result<Currency, Error>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<Currency> for Value

fn from(v: Currency) -> Self

Converts to this type from the input type.

impl From<CurrencyInner> for Currency

fn from(value: CurrencyInner) -> Self

Converts to this type from the input type.

impl From<Decimal> for Currency

fn from(value: Decimal) -> Self

Converts to this type from the input type.

impl FromStr for Currency

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for Currency

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<CurrencyInner> for Currency

fn into(self) -> CurrencyInner

Converts this type into the (usually inferred) input type.

impl Mul for Currency

type Output = Result<Currency, Error>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Neg for Currency

type Output = Result<Currency, Error>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Currency

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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: &Rhs) -> bool

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

impl PartialOrd for Currency

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

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

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

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

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

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

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

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

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

type Output = Result<Currency, Error>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Serialize for Currency

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Currency

type Output = Result<Currency, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<Array> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Bool> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Array

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Bool

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Fixed

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Float

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for I16

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for I32

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for I64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for I8

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Object

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Range

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for Str

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for U16

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for U32

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for U64

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Currency> for U8

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Fixed> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Float> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I16> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I32> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I64> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<I8> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Object> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Range> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Str> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U16> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U32> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U64> for Currency

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<U8> for Currency

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl ValueTrait for Currency

type Inner = CurrencyInner

The inner type of the value

fn new(inner: CurrencyInner) -> Self

Creates a new value from the given inner value

fn inner(&self) -> &CurrencyInner

Returns a reference to the inner value

fn inner_mut(&mut self) -> &mut CurrencyInner

Returns a mutable reference to the inner value

fn into_inner(self) -> CurrencyInner

Consumes the value and returns the inner value

impl Deref for Currency

type Target = <Currency as ValueTrait>::Inner

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Currency

impl StructuralPartialEq for Currency