Struct plutus_ledger_api::v1::value::Value

pub struct Value(pub BTreeMap<CurrencySymbol, BTreeMap<TokenName, BigInt>>);

A value that can contain multiple asset classes

Tuple Fields

0: BTreeMap<CurrencySymbol, BTreeMap<TokenName, BigInt>>

Implementations

impl Value

pub fn new() -> Self

pub fn ada_value(amount: &BigInt) -> Self

Create a Value containing only ada tokens, given the quantity in lovelace.

pub fn token_value(cs: &CurrencySymbol, tn: &TokenName, amount: &BigInt) -> Self

Create a Value containing only the given quantity of the given token.

pub fn get_token_amount(&self, cs: &CurrencySymbol, tn: &TokenName) -> BigInt

Lookup the quantity of the given token.

pub fn get_ada_amount(&self) -> BigInt

Lookup the quantity of ada(unit: lovelace).

pub fn insert_token( &self, cs: &CurrencySymbol, tn: &TokenName, a: &BigInt, ) -> Self

Insert a new token into the value, or replace the existing quantity.

pub fn is_empty(&self) -> bool

Return true if the value don’t have any entries.

pub fn normalize(self) -> Self

Remove all tokens whose quantity is zero.

pub fn map_amount<F>(self, f: F) -> Self

where F: FnMut(&CurrencySymbol, &TokenName, &BigInt) -> BigInt,

Apply a function to each token of the value, and use its result as the new amount.

pub fn filter<F>(self, f: F) -> Self

where F: FnMut(&CurrencySymbol, &TokenName, &BigInt) -> bool,

Apply a predicate to tokens.

pub fn filter_map_amount<F>(self, f: F) -> Self

where F: FnMut(&CurrencySymbol, &TokenName, &BigInt) -> Option<BigInt>,

Apply a function to each token of the value. If the result is None, the token entry will be removed.

Note that if the name-quantity map of any given currency symbols is empty, the currency entry will be removed from the top-level map entirely.

Trait Implementations

impl<'a, 'b> Add<&'a Value> for &'b Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<&'a Value> for Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<Value> for &'a Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Value

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

fn to_plutus_data(&self) -> PlutusData

fn from_plutus_data(data: &PlutusData) -> Result<Self, PlutusDataError>

impl Mul<&BigInt> for &Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a BigInt> for Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b> Mul<&'a Value> for &'b BigInt

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for BigInt

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for i16

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for i32

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for i64

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for i8

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for u16

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for u32

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for u64

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Value> for u8

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<BigInt> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<BigInt> for Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<Value> for &'a BigInt

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Value> for BigInt

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<i16> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<i32> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<i64> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<i8> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<u16> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<u32> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<u64> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<u8> for &'a Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for &Value

type Output = Value

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Value

type Output = Value

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Value

fn cmp(&self, other: &Value) -> 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 Value

fn eq(&self, other: &Value) -> 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 Value

fn partial_cmp(&self, other: &Value) -> 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<'a, 'b> Sub<&'a Value> for &'b Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<&'a Value> for Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Value> for &'a Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sum<&'a Value> for Value

fn sum<I: Iterator<Item = &'a Value>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Value

fn sum<I: Iterator<Item = Value>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Zero for Value

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Eq for Value

impl StructuralPartialEq for Value