Struct multiversx_sc::types::heap::BoxedBytes

pub struct BoxedBytes(_);

Simple wrapper around a boxed byte slice, but with a lot of optimized methods for manipulating it. The focus is on reducing code size rather improving speed.

Implementations

impl BoxedBytes

pub fn empty() -> Self

pub fn zeros(len: usize) -> Self

pub unsafe fn allocate(len: usize) -> Self

Allocates an uninitialized BoxedBytes to heap.

Safety

Should only be called if the contents are initialized immediately afterwards, e.g. via a FFI call.

pub fn as_ptr(&self) -> *const u8

pub fn as_mut_ptr(&mut self) -> *mut u8

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn into_box(self) -> Box<[u8]>

pub fn into_vec(self) -> Vec<u8>

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

pub fn as_mut_slice(&mut self) -> &mut [u8]

pub fn from_concat(slices: &[&[u8]]) -> Self

Create new instance by concatenating several byte slices.

pub fn split(self, at: usize) -> (BoxedBytes, BoxedBytes)

Splits BoxedBytes into 2 others at designated position. Returns the original and an empty BoxedBytes if position arugment out of range.

Trait Implementations

impl AsRef<[u8]> for BoxedBytes

fn as_ref(&self) -> &[u8]

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

impl Clone for BoxedBytes

fn clone(&self) -> BoxedBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoxedBytes

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for BoxedBytes

fn from(byte_slice: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<&Vec<u8, Global>> for BoxedBytes

fn from(v: &Vec<u8>) -> Self

Converts to this type from the input type.

impl From<Box<[u8], Global>> for BoxedBytes

fn from(b: Box<[u8]>) -> Self

Converts to this type from the input type.

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

fn from(bytes: BoxedBytes) -> Self

Converts to this type from the input type.

impl<M> From<BoxedBytes> for ManagedSCError<M>where M: ManagedTypeApi + ErrorApi,

fn from(message: BoxedBytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for BoxedBytes

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

Converts to this type from the input type.

impl NestedDecode for BoxedBytes

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H ) -> Result<Self, H::HandledErr>where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

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.

impl NestedEncode for BoxedBytes

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H ) -> Result<(), H::HandledErr>where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

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

impl PartialEq<BoxedBytes> for BoxedBytes

fn eq(&self, other: &BoxedBytes) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TopDecode for BoxedBytes

fn top_decode_or_handle_err<I, H>( input: I, _h: H ) -> Result<Self, H::HandledErr>where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

Attempt to deserialize the value from input.

impl TopEncode for BoxedBytes

fn top_encode_or_handle_err<O, H>( &self, output: O, _h: H ) -> Result<(), H::HandledErr>where O: TopEncodeOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

Attempt to serialize the value to ouput.

impl TopEncodeOutput for &mut BoxedBytes

This allows us to use a mutable BoxedBytes as top encode output.

type NestedBuffer = Vec<u8, Global>

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

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

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

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

fn set_u64(self, value: u64)

fn set_i64(self, value: i64)

fn supports_specialized_type<T>() -> boolwhere T: TryStaticCast,

fn set_specialized<T, H>( self, _value: &T, h: H ) -> Result<(), <H as EncodeErrorHandler>::HandledErr>where T: TryStaticCast, H: EncodeErrorHandler,

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.

impl TypeAbi for BoxedBytes

fn type_name() -> TypeName

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

A type can provide more than its own name. 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> CodecFrom<&BoxedBytes> for ManagedBuffer<M>

impl<M: ManagedTypeApi> CodecFrom<&ManagedBuffer<M>> for BoxedBytes

impl<M: ManagedTypeApi> CodecFrom<BoxedBytes> for ManagedBuffer<M>

impl<M: ManagedTypeApi> CodecFrom<ManagedBuffer<M>> for BoxedBytes

impl CodecFrom<OperationCompletionStatus> for BoxedBytes

impl Eq for BoxedBytes

impl StructuralEq for BoxedBytes

impl StructuralPartialEq for BoxedBytes