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.

Implementations§

source§

impl BoxedBytes

source

pub fn empty() -> Self

source

pub fn zeros(len: usize) -> Self

source

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.

source

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

source

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

source

pub fn len(&self) -> usize

source

pub fn is_empty(&self) -> bool

source

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

source

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

source

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

source

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

source

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

Create new instance by concatenating several byte slices.

source

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§

source§

impl AsRef<[u8]> for BoxedBytes

source§

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

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

impl Clone for BoxedBytes

source§

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
source§

impl Debug for BoxedBytes

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<&Vec<u8>> for BoxedBytes

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Vec<u8>> for BoxedBytes

source§

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

Converts to this type from the input type.
source§

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

source§

fn managed_from(api: M, bytes: BoxedBytes) -> Self

source§

impl<M> ManagedFrom<M, BoxedBytes> for ManagedSCError<M>
where M: ManagedTypeApi,

source§

fn managed_from(api: M, message: BoxedBytes) -> Self

source§

impl NestedDecode for BoxedBytes

source§

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.
source§

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.
source§

impl NestedEncode for BoxedBytes

source§

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.
source§

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

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.
source§

impl PartialEq for BoxedBytes

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl TopDecode for BoxedBytes

source§

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

Attempt to deserialize the value from input.
source§

fn top_decode_or_exit<I: TopDecodeInput, ExitCtx: Clone>( input: I, _: ExitCtx, _: 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.
source§

impl TopEncode for BoxedBytes

source§

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

Attempt to serialize the value to ouput.
source§

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

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.
source§

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.
source§

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

source§

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

source§

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

source§

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

source§

fn set_u64(self, value: u64)

source§

fn set_i64(self, value: i64)

source§

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.
source§

impl TypeAbi for BoxedBytes

source§

fn type_name() -> String

source§

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.
source§

impl Eq for BoxedBytes

source§

impl StructuralEq for BoxedBytes

source§

impl StructuralPartialEq for BoxedBytes

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

fn push_dyn_arg<O>(&self, output: &mut O)
where O: DynArgOutput,

source§

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

source§

fn dyn_load<I>(loader: &mut I, arg_id: ArgId) -> T
where I: DynArgInput,

source§

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

§

type DecodeAs = T

Indicates how the result of the endpoint can be interpreted when called via proxy. Self for most types.
source§

fn finish<FA>(&self, api: FA)
where FA: ManagedTypeApi + EndpointFinishApi + Clone + 'static,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<M, F> ManagedFrom<M, F> for F
where M: ManagedTypeApi,

source§

fn managed_from(_: M, t: F) -> F

source§

impl<M, F, T> ManagedInto<M, T> for F
where T: ManagedFrom<M, F>, M: ManagedTypeApi,

source§

fn managed_into(self, api: M) -> T

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.