Struct scrypto::prelude::RawPayload

pub struct RawPayload<'a, E>
where
    E: CustomExtension,
{
    full_payload: Cow<'a, [u8]>,
    root_value_kind: ValueKind<<E as CustomExtension>::CustomValueKind>,
    custom_extension: PhantomData<E>,
}

A wrapper for a full encoded SBOR payload, including the prefix byte.

Encode is implemented, but Decode is not - because the payload needs to be checked to be valid. Instead, you can use the typed or untyped traverser to validate the payload.

The payload is assumed to be valid, and for performance, the payload is encoded directly without checking if it is valid.

If you need to check the validity of a payload first:

• If you have a schema - use the typed traverser
• If it is schemaless - use the untyped traverser

Fields

full_payload: Cow<'a, [u8]>

root_value_kind: ValueKind<<E as CustomExtension>::CustomValueKind>

custom_extension: PhantomData<E>

Implementations

impl<'a, E> RawPayload<'a, E>

where E: CustomExtension,

pub fn new_from_valid_slice(payload_bytes: &'a [u8]) -> RawPayload<'a, E>

The bytes should include the prefix byte (eg 0x5b for basic SBOR).

It is the caller’s responsibility to ensure that a valid SBOR payload for extension E is passed to the caller.

This constructor does not check the prefix byte, and panics if the root value kind is invalid.

pub fn new_from_valid_slice_with_checks( payload_bytes: &'a [u8] ) -> Option<RawPayload<'a, E>>

The bytes should include the prefix byte (eg 0x5b for basic SBOR).

It is the caller’s responsibility to ensure that a valid SBOR payload for extension E is passed to the caller.

Unlike new_from_valid_payload_bytes, the constructor includes a prefix byte check to hopefully catch some errors - but it is not guaranteed to catch all errors.

pub fn new_from_valid_owned(payload_bytes: Vec<u8>) -> RawPayload<'a, E>

The bytes should include the prefix byte (eg 0x5b for basic SBOR).

It is the caller’s responsibility to ensure that a valid SBOR payload for extension E is passed to the caller.

This constructor does not check the prefix byte, and panics if the root value kind is invalid.

pub fn new_from_valid_owned_with_checks( payload_bytes: Vec<u8> ) -> Option<RawPayload<'a, E>>

The bytes should include the prefix byte (eg 0x5b for basic SBOR).

It is the caller’s responsibility to ensure that a valid SBOR payload for extension E is passed to the caller.

Unlike new_from_valid_payload_bytes, the constructor includes a prefix byte check to hopefully catch some errors - but it is not guaranteed to catch all errors.

pub fn as_encoded_value<'b>(&'b self) -> RawValue<'b, E>

pub fn decode_into<T>(&self, depth_limit: usize) -> Result<T, DecodeError>

where T: for<'b> Decode<<E as CustomExtension>::CustomValueKind, VecDecoder<'b, <E as CustomExtension>::CustomValueKind>>,

pub fn root_value_kind( &self ) -> ValueKind<<E as CustomExtension>::CustomValueKind>

pub fn payload_bytes(&self) -> &[u8]

pub fn encoded_root_value_bytes(&self) -> &[u8]

pub fn encoded_root_body_bytes(&self) -> &[u8]

Trait Implementations

impl<'s, 'a, 'b, E> ContextualDisplay<ValueDisplayParameters<'s, 'a, E>> for RawPayload<'b, E>

where E: FormattableCustomExtension,

type Error = FormattingError

fn contextual_format<F>( &self, f: &mut F, options: &ValueDisplayParameters<'s, 'a, E> ) -> Result<(), <RawPayload<'b, E> as ContextualDisplay<ValueDisplayParameters<'s, 'a, E>>>::Error>

where F: Write,

Formats the value to the given fmt::Write buffer, making use of the provided context. See also format, which is typically easier to use, as it takes an Into<Context> instead of a &Context.

fn format<F, TContext>( &self, f: &mut F, context: TContext ) -> Result<(), Self::Error>

where F: Write, TContext: Into<Context>,

Formats the value to the given fmt::Write buffer, making use of the provided context. See also contextual_format, which takes a &Context instead of an Into<Context>.

fn display<TContext, 'a, 'b>( &'a self, context: TContext ) -> ContextDisplayable<'a, Self, Context>

where TContext: Into<Context>,

Returns an object implementing fmt::Display, which can be used in a format! style macro.

fn to_string<TContext, 'a, 'b>(&'a self, context: TContext) -> String

where TContext: Into<Context>,

impl<'s, 'a, 'b, E> ContextualSerialize<SerializationParameters<'s, 'a, E>> for RawPayload<'b, E>

where E: SerializableCustomExtension,

fn contextual_serialize<S>( &self, serializer: S, context: &SerializationParameters<'s, 'a, E> ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes the value to the given serde::Serializer, making use of the provided context. See also serialize, which is typically easier to use, as it takes an Into<Context> instead of a &Context.

fn serialize<S, TContext>( &self, serializer: S, context: TContext ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer, TContext: Into<Context>,

Serializes the value to the given serde::Serializer, making use of the provided context. See also contextual_serialize, which takes a &Context instead of an Into<Context>.

fn serializable<TContext, 'a, 'b>( &'a self, context: TContext ) -> ContextSerializable<'a, Self, Context>

where TContext: Into<Context>,

Returns an object implementing serde::Serialize, which can be passed to serde functions.

impl<Ext, E> Encode<<Ext as CustomExtension>::CustomValueKind, E> for RawPayload<'_, Ext>

where Ext: CustomExtension, E: Encoder<<Ext as CustomExtension>::CustomValueKind>,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl<'a, E> TryFrom<&'a [u8]> for RawPayload<'a, E>

where E: CustomExtension,

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8] ) -> Result<RawPayload<'a, E>, <RawPayload<'a, E> as TryFrom<&'a [u8]>>::Error>

Performs the conversion.