Struct ManagedByteArray

pub struct ManagedByteArray<M, const N: usize>
where
    M: ManagedTypeApi,
{ /* private fields */ }

A list of items that lives inside a managed buffer. Items can be either stored there in full (e.g. u32), or just via handle (e.g. BigUint<M>).

Implementations

impl<M, const N: usize> ManagedByteArray<M, N>

where M: ManagedTypeApi,

pub fn new_from_bytes(bytes: &[u8; N]) -> ManagedByteArray<M, N>

pub unsafe fn new_uninit() -> ManagedByteArray<M, N>

Creates a new object, without initializing it.

Safety

The value needs to be initialized after creation, otherwise the VM will halt the first time the value is attempted to be read.

pub fn len(&self) -> usize

Number of items.

pub fn is_empty(&self) -> bool

pub fn as_managed_buffer(&self) -> &ManagedBuffer<M>

pub fn to_byte_array(&self) -> [u8; N]

Trait Implementations

impl<M, const N: usize> Clone for ManagedByteArray<M, N>

where M: Clone + ManagedTypeApi,

fn clone(&self) -> ManagedByteArray<M, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, const N: usize> Debug for ManagedByteArray<M, N>

where M: ManagedTypeApi,

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

Formats the value using the given formatter.

impl<M, const N: usize> Default for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn default() -> ManagedByteArray<M, N>

Returns the “default value” for a type.

impl<M, const N: usize> From<&[u8; N]> for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn from(bytes: &[u8; N]) -> ManagedByteArray<M, N>

Converts to this type from the input type.

impl<M> From<ManagedByteArray<M, 32>> for ManagedAddress<M>

where M: ManagedTypeApi,

fn from(value: ManagedByteArray<M, 32>) -> ManagedAddress<M>

Converts to this type from the input type.

impl<M, const N: usize> ManagedType<M> for ManagedByteArray<M, N>

where M: ManagedTypeApi,

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

fn get_handle(&self) -> <M as HandleTypeInfo>::ManagedBufferHandle

unsafe fn forget_into_handle( self, ) -> <ManagedByteArray<M, N> as ManagedType<M>>::OwnHandle

Forgets current object (does not run destructor), but extracts the handle.

fn transmute_from_handle_ref( handle_ref: &<M as HandleTypeInfo>::ManagedBufferHandle, ) -> &ManagedByteArray<M, N>

Implement carefully, since the underlying transmutation is an unsafe operation. For types that wrap a handle to some VM-managed data, make sure the type only contains the handle (plus ZSTs if necessary). For types that just wrap another managed type it is easier, call for the wrapped object.

fn transmute_from_handle_ref_mut( handle_ref: &mut <M as HandleTypeInfo>::ManagedBufferHandle, ) -> &mut ManagedByteArray<M, N>

fn get_raw_handle(&self) -> i32

fn as_ref(&self) -> ManagedRef<'_, M, Self>

impl<M, const N: usize> ManagedVecItem for ManagedByteArray<M, N>

where M: ManagedTypeApi,

const SKIPS_RESERIALIZATION: bool = false

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).

type PAYLOAD = ManagedVecItemPayloadBuffer<4>

Type managing the underlying binary representation in a ManagedVec..

type Ref<'a> = ManagedRef<'a, M, ManagedByteArray<M, N>>

Reference representation of the ManagedVec item.

fn read_from_payload( payload: &<ManagedByteArray<M, N> as ManagedVecItem>::PAYLOAD, ) -> ManagedByteArray<M, N>

Parses given bytes as a an owned object.

unsafe fn borrow_from_payload<'a>( payload: &<ManagedByteArray<M, N> as ManagedVecItem>::PAYLOAD, ) -> <ManagedByteArray<M, N> as ManagedVecItem>::Ref<'a>

Parses given bytes as a representation of the object, either owned, or a reference.

fn save_to_payload( self, payload: &mut <ManagedByteArray<M, N> as ManagedVecItem>::PAYLOAD, )

Converts the object into bytes.

fn payload_size() -> usize

impl<M, const N: usize> NestedDecode for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<ManagedByteArray<M, N>, <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<M, const N: usize> NestedEncode for ManagedByteArray<M, N>

where M: ManagedTypeApi,

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<M, const N: usize> PartialEq for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn eq(&self, other: &ManagedByteArray<M, N>) -> bool

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

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<M, const N: usize> SCLowerHex for ManagedByteArray<M, N>

where M: ManagedTypeApi,

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

where F: FormatByteReceiver,

impl<M, const N: usize> TopDecode for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn top_decode_or_handle_err<I, H>( input: I, h: H, ) -> Result<ManagedByteArray<M, N>, <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<M, const N: usize> TopEncode for ManagedByteArray<M, N>

where M: ManagedTypeApi,

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<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<ManagedByteArray<M, N>, <ManagedByteArray<M, N> as TryFrom<ManagedBuffer<M>>>::Error>

Performs the conversion.

impl<M, const N: usize> TypeAbi for ManagedByteArray<M, N>

where M: ManagedTypeApi,

fn type_name() -> String

It is semantically equivalent to [u8; N].

type Unmanaged = [u8; N]

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<M, const N: usize> Eq for ManagedByteArray<M, N>

where M: ManagedTypeApi,

impl<M, const N: usize> TypeAbiFrom<&ManagedByteArray<M, N>> for ManagedByteArray<M, N>

where M: ManagedTypeApi,

impl<M, const N: usize> TypeAbiFrom<ManagedByteArray<M, N>> for ManagedByteArray<M, N>

where M: ManagedTypeApi,