Struct RawValue

pub struct RawValue<'a, E>
where
    E: CustomExtension,
{ /* private fields */ }

A wrapper for a reference to a valid partial SBOR payload representing a single value.

Encode, Decode and Describe are implemented:

• For performance, the payload is encoded directly without checking if it is valid.
• Decoding goes through a traverser, which calculates the length of the bytes and ensures that the bytes are actually valid.
• Describe is implemented as Any.

Categorize can’t be implemented, because we can’t guarantee the value kind is constant. This means RawValue can’t be put as an immediate child to a Vec or Map.

Implementations

impl<'a, E> RawValue<'a, E>

where E: CustomExtension,

pub fn new_from_valid_full_value_slice( encoded_full_value: &'a [u8], ) -> RawValue<'a, E>

The bytes should include the value kind byte, but not the payload prefix byte.

The bytes must be at least 1 byte long, else this will panic.

pub fn new_from_valid_value_body_slice( value_kind: ValueKind<<E as CustomExtension>::CustomValueKind>, encoded_value_body: &'a [u8], ) -> RawValue<'a, E>

The bytes should include the value, not the value kind or the prefix byte

pub fn new_from_valid_owned_value_body( value_kind: ValueKind<<E as CustomExtension>::CustomValueKind>, encoded_value_body: Vec<u8>, ) -> RawValue<'a, E>

The bytes should include the value, not the value kind or the prefix byte

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

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

Trait Implementations

impl<'a, E> Clone for RawValue<'a, E>

where E: Clone + CustomExtension, <E as CustomExtension>::CustomValueKind: Clone,

fn clone(&self) -> RawValue<'a, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where E: FormattableCustomExtension,

type Error = FormattingError

fn contextual_format<F>( &self, f: &mut F, options: &ValueDisplayParameters<'s, 'a, E>, ) -> Result<(), <RawValue<'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<'a, 'b, TContext>( &'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<'a, 'b, TContext>(&'a self, context: TContext) -> String

where TContext: Into<Context>,

impl<'a, E> Debug for RawValue<'a, E>

where E: Debug + CustomExtension, <E as CustomExtension>::CustomValueKind: Debug,

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

Formats the value using the given formatter.

impl<Ext, D> Decode<<Ext as CustomExtension>::CustomValueKind, D> for RawValue<'_, Ext>

where Ext: CustomExtension, D: Decoder<<Ext as CustomExtension>::CustomValueKind>,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<<Ext as CustomExtension>::CustomValueKind>, ) -> Result<RawValue<'_, Ext>, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<Ext, C> Describe<C> for RawValue<'_, Ext>

where Ext: CustomExtension, C: CustomTypeKind<RustTypeId>,

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<Ext, E> Encode<<Ext as CustomExtension>::CustomValueKind, E> for RawValue<'_, 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.