Struct PlutusData

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

Implementations

impl PlutusData

pub fn to_cardano_node_format(&self) -> Self

• Convert to a Datum that will serialize equivalent to cardano-node’s format
• Please VERY STRONGLY consider using PlutusData::from_cbor_bytes() instead wherever possible.
• You should try to never rely on a tool encoding CBOR a certain way as there are many possible,
• and just because it matches with a specific datum, doesn’t mean that a different datum won’t differ.
• This is critical as that means the datum hash won’t match.
• After creation a datum (or other hashable CBOR object) should only be treated as raw CBOR bytes,
• or through a type that respects its specific CBOR format e.g. CML’s PlutusData::from_cbor_bytes()
• This function is just here in case there’s no possible way at all to create from CBOR bytes and
• thus cold only be constructed manually and then had this function called on it.
• This is also the format that CSL and Lucid use

impl PlutusData

pub fn to_cbor_bytes(&self) -> Vec<u8>

• Serialize this type to CBOR bytes
• This type type supports encoding preservation so this will preserve round-trip CBOR formats.
• If created from scratch the CBOR will be canonical.

pub fn to_canonical_cbor_bytes(&self) -> Vec<u8>

• Serialize this type to CBOR bytes using canonical CBOR encodings

pub fn from_cbor_bytes(cbor_bytes: &[u8]) -> Result<PlutusData, JsError>

• Create this type from CBOR bytes

pub fn to_cbor_hex(&self) -> String

• Serialize this type to CBOR bytes encoded as a hex string (useful for working with CIP30).
• This type type supports encoding preservation so this will preserve round-trip CBOR formats.
• If created from scratch the CBOR will be canonical.

pub fn to_canonical_cbor_hex(&self) -> String

• Serialize this type to CBOR bytes using canonical CBOR encodings as hex bytes

pub fn from_cbor_hex(cbor_bytes: &str) -> Result<PlutusData, JsError>

• Create this type from the CBOR bytes encoded as a hex string.
• This is useful for interfacing with CIP30

impl PlutusData

pub fn to_json(&self) -> Result<String, JsError>

pub fn to_js_value(&self) -> Result<JsValue, JsError>

pub fn from_json(json: &str) -> Result<PlutusData, JsError>

impl PlutusData

pub fn new_constr_plutus_data(constr_plutus_data: &ConstrPlutusData) -> Self

pub fn new_map(map: &PlutusMap) -> Self

pub fn new_list(list: &PlutusDataList) -> Self

pub fn new_integer(big_int: &BigInteger) -> Self

pub fn new_bytes(bytes: Vec<u8>) -> Self

pub fn kind(&self) -> PlutusDataKind

pub fn as_constr_plutus_data(&self) -> Option<ConstrPlutusData>

pub fn as_map(&self) -> Option<PlutusMap>

pub fn as_list(&self) -> Option<PlutusDataList>

pub fn as_integer(&self) -> Option<BigInteger>

pub fn as_bytes(&self) -> Option<Vec<u8>>

Trait Implementations

impl AsRef<PlutusData> for PlutusData

fn as_ref(&self) -> &PlutusData

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PlutusData

fn clone(&self) -> PlutusData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlutusData

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

Formats the value using the given formatter.

impl From<PlutusData> for JsValue

fn from(value: PlutusData) -> Self

Converts to this type from the input type.

impl From<PlutusData> for PlutusData

fn from(native: PlutusData) -> Self

Converts to this type from the input type.

impl FromWasmAbi for PlutusData

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl Into<PlutusData> for PlutusData

fn into(self) -> PlutusData

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

impl IntoWasmAbi for PlutusData

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for PlutusData

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<PlutusData>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for PlutusData

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for PlutusData

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for PlutusData

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<PlutusData>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for PlutusData

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<PlutusData>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for PlutusData

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for PlutusData

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[PlutusData]>

impl VectorIntoJsValue for PlutusData

fn vector_into_jsvalue(vector: Box<[PlutusData]>) -> JsValue

impl VectorIntoWasmAbi for PlutusData

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[PlutusData]>) -> Self::Abi

impl WasmDescribe for PlutusData

fn describe()

impl WasmDescribeVector for PlutusData

fn describe_vector()

impl SupportsConstructor for PlutusData

impl SupportsInstanceProperty for PlutusData

impl SupportsStaticProperty for PlutusData