Struct elrond_wasm::types::ManagedBuffer

pub struct ManagedBuffer<M: ManagedTypeApi> { /* fields omitted */ }

A byte buffer managed by an external API.

Implementations

impl<M: ManagedTypeApi> ManagedBuffer<M>

pub fn new() -> Self

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

impl<M: ManagedTypeApi> ManagedBuffer<M>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn to_boxed_bytes(&self) -> BoxedBytes

pub fn load_slice(
    &self,
    starting_position: usize,
    dest_slice: &mut [u8]
) -> Result<(), InvalidSliceError>

TODO: investigate the impact of using Result<(), ()> on the wasm output.

pub fn copy_slice(
    &self,
    starting_position: usize,
    slice_len: usize
) -> Option<ManagedBuffer<M>>

pub fn overwrite(&mut self, value: &[u8])

pub fn set_slice(
    &mut self,
    starting_position: usize,
    source_slice: &[u8]
) -> Result<(), InvalidSliceError>

pub fn append(&mut self, other: &ManagedBuffer<M>)

pub fn append_bytes(&mut self, slice: &[u8])

pub fn append_u32_be(&mut self, item: u32)

Utility function: helps serialize lengths (or any other value of type usize) easier.

pub fn parse_as_u64(&self) -> Option<u64>

Trait Implementations

impl<M: ManagedTypeApi> Clone for ManagedBuffer<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: ManagedTypeApi> Debug for ManagedBuffer<M>

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

Formats the value using the given formatter.

impl<M: ManagedTypeApi> Default for ManagedBuffer<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M, const N: usize> From<&'_ [u8; N]> for ManagedBuffer<M> where
    M: ManagedTypeApi, 

Syntactic sugar only.

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

Performs the conversion.

impl<M> From<&'_ [u8]> for ManagedBuffer<M> where
    M: ManagedTypeApi, 

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

Performs the conversion.

impl<M: ManagedTypeApi> From<&'_ ManagedBuffer<M>> for BigInt<M>

fn from(item: &ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M: ManagedTypeApi> From<&'_ ManagedBuffer<M>> for BigUint<M>

fn from(item: &ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M> From<BoxedBytes> for ManagedBuffer<M> where
    M: ManagedTypeApi, 

fn from(bytes: BoxedBytes) -> Self

Performs the conversion.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for StorageKey<M>

fn from(buffer: ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for TokenIdentifier<M>

fn from(buffer: ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M> From<ManagedBuffer<M>> for ManagedSCError<M> where
    M: ManagedTypeApi, 

fn from(message: ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for BigInt<M>

fn from(item: ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M: ManagedTypeApi> From<ManagedBuffer<M>> for BigUint<M>

fn from(item: ManagedBuffer<M>) -> Self

Performs the conversion.

impl<M> From<Vec<u8, Global>> for ManagedBuffer<M> where
    M: ManagedTypeApi, 

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

Performs the conversion.

impl<M: ManagedTypeApi> ManagedType<M> for ManagedBuffer<M>

fn type_manager(&self) -> M

impl<M: ManagedTypeApi> ManagedVecItem for ManagedBuffer<M>

const PAYLOAD_SIZE: usize

Size of the data stored in the underlying ManagedBuffer.

const SKIPS_RESERIALIZATION: bool

If true, then the encoding of the item is identical to the payload, and no further conversion is necessary (the underlying buffer can be used as-is during serialization). False for all managed types, but true for basic types (like u32).

fn from_byte_reader<Reader: FnMut(&mut [u8])>(reader: Reader) -> Self

fn to_byte_writer<R, Writer: FnMut(&[u8]) -> R>(&self, writer: Writer) -> R

impl<M: ManagedTypeApi> NestedDecode for ManagedBuffer<M>

fn dep_decode<I: NestedDecodeInput>(input: &mut I) -> Result<Self, DecodeError>

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

fn dep_decode_or_exit<I: NestedDecodeInput, ExitCtx: Clone>(
    input: &mut I,
    c: ExitCtx,
    exit: fn(_: ExitCtx, _: DecodeError) -> !
) -> Self

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<M: ManagedTypeApi> NestedEncode for ManagedBuffer<M>

fn dep_encode<O: NestedEncodeOutput>(
    &self,
    dest: &mut O
) -> Result<(), EncodeError>

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

fn dep_encode_or_exit<O, ExitCtx>(
    &self,
    dest: &mut O,
    c: ExitCtx,
    exit: fn(ExitCtx, EncodeError) -> !
) where
    O: NestedEncodeOutput,
    ExitCtx: Clone, 

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<M: ManagedTypeApi> NestedEncodeOutput for ManagedBuffer<M>

fn write(&mut self, bytes: &[u8])

Write to the output.

fn push_specialized<T, C, F>(
    &mut self,
    context: C,
    value: &T,
    else_serialization: F
) -> Result<(), EncodeError> where
    T: TryStaticCast,
    C: TryStaticCast,
    F: FnOnce(&mut Self) -> Result<(), EncodeError>, 

fn push_byte(&mut self, byte: u8)

Write a single byte to the output.

impl<M: ManagedTypeApi, const N: usize> PartialEq<&'_ [u8; N]> for ManagedBuffer<M>

fn eq(&self, other: &&[u8; N]) -> 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 !=.

impl<M: ManagedTypeApi> PartialEq<[u8]> for ManagedBuffer<M>

fn eq(&self, other: &[u8]) -> 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 !=.

impl<M: ManagedTypeApi> PartialEq<ManagedBuffer<M>> for ManagedBuffer<M>

fn eq(&self, other: &Self) -> 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 !=.

impl<M: ManagedTypeApi> TopDecode for ManagedBuffer<M>

fn top_decode<I: TopDecodeInput>(input: I) -> Result<Self, DecodeError>

Attempt to deserialize the value from input.

fn top_decode_or_exit<I, ExitCtx>(
    input: I,
    c: ExitCtx,
    exit: fn(ExitCtx, DecodeError) -> !
) -> Self where
    I: TopDecodeInput,
    ExitCtx: Clone, 

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<M> TopDecodeInput for ManagedBuffer<M> where
    M: ManagedTypeApi, 

type NestedBuffer = ManagedBufferNestedDecodeInput<M>

fn byte_len(&self) -> usize

Length of the underlying data, in bytes.

fn into_boxed_slice_u8(self) -> Box<[u8]>

Provides the underlying data as an owned byte slice box. Consumes the input object in the process.

fn into_u64(self) -> u64

Retrieves the underlying data as a pre-parsed u64. Expected to panic if the conversion is not possible.

fn into_specialized<T, F>(self, else_deser: F) -> Result<T, DecodeError> where
    T: TryStaticCast,
    F: FnOnce(Self) -> Result<T, DecodeError>, 

fn into_nested_buffer(self) -> Self::NestedBuffer

fn into_i64(self) -> i64

Retrieves the underlying data as a pre-parsed i64. Expected to panic if the conversion is not possible.

fn into_specialized_or_exit<T, F, ExitCtx>(
    self,
    c: ExitCtx,
    exit: fn(ExitCtx, DecodeError) -> !,
    else_deser: F
) -> T where
    T: TryStaticCast,
    ExitCtx: Clone,
    F: FnOnce(Self, ExitCtx, fn(ExitCtx, DecodeError) -> !) -> T, 

Note: currently not in use.

impl<M: ManagedTypeApi> TopEncode for ManagedBuffer<M>

fn top_encode<O: TopEncodeOutput>(&self, output: O) -> Result<(), EncodeError>

Attempt to serialize the value to ouput.

fn top_encode_or_exit<O, ExitCtx>(
    &self,
    output: O,
    c: ExitCtx,
    exit: fn(ExitCtx, EncodeError) -> !
) where
    O: TopEncodeOutput,
    ExitCtx: Clone, 

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller bytecode implementations in cases where the application is supposed to exit directly on decode error.

impl<M: ManagedTypeApi> TopEncodeOutput for &mut ManagedBuffer<M>

type NestedBuffer = ManagedBuffer<M>

Type of NestedEncodeOutput that can be spawned to gather serializations of children.

fn set_slice_u8(self, bytes: &[u8])

fn set_u64(self, value: u64)

fn set_i64(self, value: i64)

fn set_specialized<T, F>(
    self,
    value: &T,
    else_serialization: F
) -> Result<(), EncodeError> where
    T: TryStaticCast,
    F: FnOnce(Self) -> Result<(), EncodeError>, 

Allows special handling of special types. Also requires an alternative serialization, in case the special handling is not covered. The alternative serialization, else_serialization is only called when necessary and is normally compiled out via monomorphization.

fn start_nested_encode(&self) -> Self::NestedBuffer

fn finalize_nested_encode(self, nb: Self::NestedBuffer)

fn set_boxed_bytes(self, bytes: Box<[u8], Global>)

impl<M> TryFrom<ManagedBuffer<M>> for ManagedAddress<M> where
    M: ManagedTypeApi, 

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: ManagedBuffer<M>) -> Result<Self, Self::Error>

Performs the conversion.

impl<M, const N: usize> TryFrom<ManagedBuffer<M>> for ManagedByteArray<M, N> where
    M: ManagedTypeApi, 

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: ManagedBuffer<M>) -> Result<Self, Self::Error>

Performs the conversion.

impl<M: ManagedTypeApi> TryStaticCast for ManagedBuffer<M>

fn type_eq<U>() -> bool where
    U: TryStaticCast, 

fn try_cast<U>(self) -> Option<U> where
    U: TryStaticCast, 

fn try_cast_ref<U>(&self) -> Option<&U> where
    U: TryStaticCast, 

impl<M: ManagedTypeApi> TypeAbi for ManagedBuffer<M>

fn type_name() -> String

fn provide_type_descriptions<TDC: TypeDescriptionContainer>(
    accumulator: &mut TDC
)

A type can provide more than its own description. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

impl<M: ManagedTypeApi> Eq for ManagedBuffer<M>