multiversx_sc_snippets::imports

Struct BoxedBytes

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

Expand description

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.

Used to be used extensively in smart contracts, before the introduction of ManagedBuffer, but was superseded by it.

Implementations§

impl BoxedBytes

pub fn empty() -> BoxedBytes

pub fn zeros(len: usize) -> BoxedBytes

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]]) -> BoxedBytes

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for BoxedBytes

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

Formats the value using the given formatter. Read more

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

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

Converts to this type from the input type.

impl From<&Vec<u8>> for BoxedBytes

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(bytes: BoxedBytes) -> ManagedBuffer<M>

Converts to this type from the input type.

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

fn from(message: BoxedBytes) -> ManagedSCError<M>

Converts to this type from the input type.

impl From<Vec<u8>> for BoxedBytes

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

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<BoxedBytes, <H as DecodeErrorHandler>::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 as EncodeErrorHandler>::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 for BoxedBytes

fn eq(&self, other: &BoxedBytes) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

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<BoxedBytes, <H as DecodeErrorHandler>::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 as EncodeErrorHandler>::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>

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

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

fn start_nested_encode( &self, ) -> <&mut BoxedBytes as TopEncodeOutput>::NestedBuffer

fn finalize_nested_encode( self, nb: <&mut BoxedBytes as TopEncodeOutput>::NestedBuffer, )

fn set_u64(self, value: u64)

fn set_i64(self, value: i64)

fn supports_specialized_type<T>() -> bool
where 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

type Unmanaged = BoxedBytes

fn type_name() -> String

fn type_name_rust() -> String

fn type_names() -> TypeNames

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

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 Eq for BoxedBytes

impl StructuralPartialEq for BoxedBytes

impl<M> TypeAbiFrom<&BoxedBytes> for ManagedBuffer<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&ManagedBuffer<M>> for BoxedBytes
where M: ManagedTypeApi,

impl TypeAbiFrom<BoxedBytes> for BoxedBytes

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

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

impl TypeAbiFrom<OperationCompletionStatus> for BoxedBytes

Auto Trait Implementations§

impl Freeze for BoxedBytes

impl RefUnwindSafe for BoxedBytes

impl Send for BoxedBytes

impl Sync for BoxedBytes

impl Unpin for BoxedBytes

impl UnwindSafe for BoxedBytes

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> InterpretableFrom<&T> for T
where T: Clone,

fn interpret_from(from: &T, _context: &InterpreterContext) -> T

impl<T> InterpretableFrom<T> for T

fn interpret_from(from: T, _context: &InterpreterContext) -> T

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> ReconstructableFrom<&T> for T
where T: Clone,

fn reconstruct_from(from: &T, _builder: &ReconstructorContext) -> T

impl<T> ReconstructableFrom<T> for T

fn reconstruct_from(from: T, _builder: &ReconstructorContext) -> T

impl<T> SCCodec for T
where T: TopEncode,

fn fmt<F>(&self, f: &mut F)
where F: FormatByteReceiver,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToHex for T
where T: AsRef<[u8]>,

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TopDecodeMulti for T
where T: TopDecode,

const IS_SINGLE_VALUE: bool = true

Used to optimize single value loading of endpoint arguments.

fn multi_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<T, <H as DecodeErrorHandler>::HandledErr>
where I: TopDecodeMultiInput, H: DecodeErrorHandler,

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

impl<T> TopDecodeMultiLength for T
where T: TopEncode + TopDecode,

const LEN: usize = 1usize

fn get_len() -> usize

impl<T> TopEncodeMulti for T
where T: TopEncode,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::HandledErr>
where O: TopEncodeMultiOutput, 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 multi_encode<O>(&self, output: &mut O) -> Result<(), EncodeError>
where O: TopEncodeMultiOutput,

Attempt to serialize the value to ouput.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T

impl<O, T> ProxyArg<O> for T
where O: TypeAbiFrom<T>, T: TopEncodeMulti,