Struct PlutusData 

pub struct PlutusData<'a>(/* private fields */);

An arbitrary data format used by Plutus smart contracts.

It can be constructed directly using one of the two variants:

• Self::integer
• Self::bytes

And combine to form larger objects using:

• Self::list
• Self::map
• Self::constr

Implementations

impl<'a> PlutusData<'a>

pub fn integer(i: impl Into<BigInt>) -> Self

Construct a data value from an arbitrarily-sized integer.

examples

assert_eq!(
    format!("{}", PlutusData::integer(42)),
    "CBOR(182a)",
);

assert_eq!(
    format!("{}", PlutusData::integer(-14)),
    "CBOR(2d)",
);

assert_eq!(
    format!("{}", PlutusData::integer(BigInt::from(u128::MAX) + BigInt::from(u128::MAX))),
    "CBOR(c25101fffffffffffffffffffffffffffffffe)",
);

pub fn bytes(bytes: impl AsRef<[u8]>) -> Self

Construct an arbitrarily-sized byte-array value.

examples

assert_eq!(
    format!("{}", PlutusData::bytes(b"foo")),
    "CBOR(43666f6f)"
);

assert_eq!(
    format!(
        "{}",
        PlutusData::bytes(
            b"Rerum deleniti nisi ea exercitationem architecto. Quia architecto voluptates error."
        )
    ),
    "CBOR(5f5840526572756d2064656c656e697469206e69736920656120657865726369746174696f6e656d206172636869746563746f2e205175696120617263686974656374536f20766f6c75707461746573206572726f722eff)"
);

pub fn list<T: Into<Self>>(elems: impl IntoIterator<Item = T>) -> Self

Construct an arbitrarily-sized list of self::PlutusData values.

examples

assert_eq!(
    format!("{}", PlutusData::list::<PlutusData>([])),
    "CBOR(80)"
);

assert_eq!(
    format!("{}", PlutusData::list([b"foo", b"bar"])),
    "CBOR(9f43666f6f43626172ff)"
);

assert_eq!(
    format!("{}", PlutusData::list([
        PlutusData::bytes(b"foo"),
        PlutusData::list([1, 2]),
    ])),
    "CBOR(9f43666f6f9f0102ffff)"
);

pub fn map<K: Into<Self>, V: Into<Self>>( kvs: impl IntoIterator<Item = (K, V)>, ) -> Self

Construct an arbitrarily-sized list of self::PlutusData values.

examples

assert_eq!(
    format!("{}", PlutusData::map::<PlutusData, PlutusData>([])),
    "CBOR(a0)"
);

assert_eq!(
    format!(
        "{}",
        PlutusData::map([
            (b"FOO", 1),
            (b"BAR", 2),
        ]),
    ),
    "CBOR(a243464f4f014342415202)"
);

pub fn constr<T: Into<Self>>( ix: u64, fields: impl IntoIterator<Item = T>, ) -> Self

Construct a tagged variant with self::PlutusData fields.

The constructor index `ix` will typically starts at `0`, and be encoded accordingly. You may sometimes see libraries or tools working off encoded indexes (e.g. starting at `121`). This is not the case here.

examples

assert_eq!(
    format!("{}", PlutusData::constr::<PlutusData>(0, [])),
    "CBOR(d87980)"
);

assert_eq!(
    format!(
        "{}",
        PlutusData::constr(0, [
            PlutusData::constr::<PlutusData>(1, []),
            PlutusData::integer(1337),
        ]),
    ),
    "CBOR(d8799fd87a80190539ff)"
);

impl<'a> PlutusData<'a>

pub fn as_integer<T>(&'a self) -> Option<T>

where T: TryFrom<BigInt>,

pub fn as_bytes(&'a self) -> Option<&'a [u8]>

pub fn as_list(&'a self) -> Option<impl Iterator<Item = Self>>

pub fn as_map(&'a self) -> Option<impl Iterator<Item = (Self, Self)>>

pub fn as_constr(&'a self) -> Option<(u64, impl Iterator<Item = Self>)>

Trait Implementations

impl<'a> Clone for PlutusData<'a>

fn clone(&self) -> PlutusData<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PlutusData<'a>

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

Formats the value using the given formatter.

impl<'d, C> Decode<'d, C> for PlutusData<'static>

fn decode(d: &mut Decoder<'d>, ctx: &mut C) -> Result<Self, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<'a> Display for PlutusData<'a>

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

Formats the value using the given formatter.

impl<C> Encode<C> for PlutusData<'_>

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl From<&[u8]> for PlutusData<'static>

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl<const T: usize> From<&[u8; T]> for PlutusData<'static>

fn from(bytes: &[u8; T]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a VerificationKey> for PlutusData<'a>

fn from(key: &'a VerificationKey) -> Self

Converts to this type from the input type.

impl From<&str> for PlutusData<'static>

fn from(bytes: &str) -> Self

Converts to this type from the input type.

impl<const T: usize> From<[u8; T]> for PlutusData<'static>

fn from(bytes: [u8; T]) -> Self

Converts to this type from the input type.

impl From<BigInt> for PlutusData<'static>

fn from(int: BigInt) -> Self

Converts to this type from the input type.

impl From<PlutusData<'_>> for PlutusData

fn from(data: PlutusData<'_>) -> Self

Converts to this type from the input type.

impl From<PlutusData> for PlutusData<'static>

fn from(data: PlutusData) -> Self

Converts to this type from the input type.

impl<'a> From<Signature> for PlutusData<'a>

fn from(key: Signature) -> Self

Converts to this type from the input type.

impl From<String> for PlutusData<'static>

fn from(bytes: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for PlutusData<'static>

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<i128> for PlutusData<'static>

fn from(int: i128) -> Self

Converts to this type from the input type.

impl From<i16> for PlutusData<'static>

fn from(int: i16) -> Self

Converts to this type from the input type.

impl From<i32> for PlutusData<'static>

fn from(int: i32) -> Self

Converts to this type from the input type.

impl From<i64> for PlutusData<'static>

fn from(int: i64) -> Self

Converts to this type from the input type.

impl From<i8> for PlutusData<'static>

fn from(int: i8) -> Self

Converts to this type from the input type.

impl From<isize> for PlutusData<'static>

fn from(int: isize) -> Self

Converts to this type from the input type.

impl From<u128> for PlutusData<'static>

fn from(int: u128) -> Self

Converts to this type from the input type.

impl From<u16> for PlutusData<'static>

fn from(int: u16) -> Self

Converts to this type from the input type.

impl From<u32> for PlutusData<'static>

fn from(int: u32) -> Self

Converts to this type from the input type.

impl From<u64> for PlutusData<'static>

fn from(int: u64) -> Self

Converts to this type from the input type.

impl From<u8> for PlutusData<'static>

fn from(int: u8) -> Self

Converts to this type from the input type.

impl From<usize> for PlutusData<'static>

fn from(int: usize) -> Self

Converts to this type from the input type.

impl<'a> Ord for PlutusData<'a>

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

Restrict a value to a certain interval.

impl<'a> PartialEq for PlutusData<'a>

fn eq(&self, other: &PlutusData<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for PlutusData<'a>

fn partial_cmp(&self, other: &PlutusData<'a>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<&'a PlutusData<'a>> for &'a [u8]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a, const T: usize> TryFrom<&'a PlutusData<'a>> for &'a [u8; T]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a, const T: usize> TryFrom<&'a PlutusData<'a>> for [PlutusData<'a>; T]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a, const T: usize> TryFrom<&'a PlutusData<'a>> for (u64, [PlutusData<'a>; T])

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for (u64, Vec<PlutusData<'a>>)

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for BigInt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&PlutusData<'a>> for Signature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for Vec<(PlutusData<'a>, PlutusData<'a>)>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for Vec<PlutusData<'a>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&PlutusData<'a>> for VerificationKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for i128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for i16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for i8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for isize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for u128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for u16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for u8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a PlutusData<'a>> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: &'a PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<PlutusData<'a>> for Signature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<PlutusData<'a>> for VerificationKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: PlutusData<'a>) -> Result<Self>

Performs the conversion.

impl<'a> Eq for PlutusData<'a>

impl<'a> StructuralPartialEq for PlutusData<'a>