Struct ManagedBuffer

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

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

pub fn new_random(nr_bytes: usize) -> Self

pub fn with_buffer_contents<R, F>(&self, f: F) -> R

where M: ManagedTypeApi, F: FnOnce(&[u8]) -> R,

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

where M: ManagedTypeApi, F: FnOnce(&mut [u8]) -> &[u8],

impl<M: ManagedTypeApi> ManagedBuffer<M>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn to_boxed_bytes(&self) -> BoxedBytes

Method provided for convenience in tests, not to be used in contracts.

pub fn to_vec(&self) -> Vec<u8>

Method provided for convenience in tests, not to be used in contracts.

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 load_to_byte_array<'a, const N: usize>( &self, array: &'a mut [u8; N], ) -> &'a [u8]

pub fn for_each_batch<const BATCH_SIZE: usize, F: FnMut(&[u8])>(&self, f: F)

Loads all bytes of the managed buffer in batches, then applies given closure on each batch.

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

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

pub fn set_random(&mut self, nr_bytes: usize)

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 concat(self, other: ManagedBuffer<M>) -> Self

Concatenates 2 managed buffers. Consumes both arguments in the process.

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

Convenience method for quickly getting a top-decoded u64 from the managed buffer.

TODO: remove this method once TopDecodeInput is implemented for ManagedBuffer reference.

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

Produces a hex expression in another managed buffer, made up of “0x” + the hex representation of the data.

Trait Implementations

impl<Env> AnnotatedValue<Env, ManagedBuffer<<Env as TxEnv>::Api>> for ()

where Env: TxEnv,

fn annotation(&self, _env: &Env) -> ManagedBuffer<Env::Api>

fn to_value(&self, _env: &Env) -> ManagedBuffer<Env::Api>

Produces the value from a reference of the annotated type. Might involve a .clone() in some cases.

fn into_value(self, env: &Env) -> T

Consumes annotated value to produce actual value.

fn with_value_ref<F, R>(&self, env: &Env, f: F) -> R

where F: FnOnce(&T) -> R,

Can be used when working with references only.

impl<Env> AnnotatedValue<Env, ManagedBuffer<<Env as TxEnv>::Api>> for ManagedBuffer<Env::Api>

where Env: TxEnv,

fn annotation(&self, _env: &Env) -> ManagedBuffer<Env::Api>

fn to_value(&self, _env: &Env) -> ManagedBuffer<Env::Api>

Produces the value from a reference of the annotated type. Might involve a .clone() in some cases.

fn into_value(self, _env: &Env) -> ManagedBuffer<Env::Api>

Consumes annotated value to produce actual value.

fn with_value_ref<F, R>(&self, _env: &Env, f: F) -> R

where F: FnOnce(&ManagedBuffer<Env::Api>) -> R,

Can be used when working with references only.

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: ManagedTypeApi> Display for ManagedBuffer<M>

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

Formats the value using the given formatter.

impl<M> From<&[u8]> for ManagedBuffer<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

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

where M: ManagedTypeApi,

Syntactic sugar only.

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

Converts to this type from the input type.

impl<M: ManagedTypeApi> From<&ManagedBuffer<M>> for BigFloat<M>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<M> From<&String> for ManagedBuffer<M>

where M: ManagedTypeApi,

fn from(s: &String) -> Self

Converts to this type from the input type.

impl<M> From<&str> for ManagedBuffer<M>

where M: ManagedTypeApi,

fn from(s: &str) -> 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<Empty> for ManagedBuffer<M>

where M: ManagedTypeApi,

fn from(_: Empty) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<M> From<ManagedBuffer<M>> for ManagedBufferReadToEnd<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

impl<M> From<ManagedBuffer<M>> for ManagedSCError<M>

where M: ManagedTypeApi + ErrorApi,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<M> From<String> for ManagedBuffer<M>

where M: ManagedTypeApi,

fn from(s: String) -> Self

Converts to this type from the input type.

impl<M> From<Vec<u8>> for ManagedBuffer<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

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

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

fn get_handle(&self) -> M::ManagedBufferHandle

fn transmute_from_handle_ref(handle_ref: &M::ManagedBufferHandle) -> &Self

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 get_raw_handle(&self) -> RawHandle

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

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

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, ManagedBuffer<M>>

Reference representation of the ManagedVec item.

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

Parses given bytes as a an owned object.

unsafe fn from_byte_reader_as_borrow<'a, Reader: FnMut(&mut [u8])>( reader: Reader, ) -> Self::Ref<'a>

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

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

Converts the object into bytes.

fn payload_size() -> usize

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

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<M: ManagedTypeApi> NestedEncode for ManagedBuffer<M>

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<M: ManagedTypeApi> NestedEncodeOutput for ManagedBuffer<M>

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

Write to the output.

fn supports_specialized_type<T: TryStaticCast>() -> bool

fn push_specialized<T, C, H>( &mut self, _context: C, value: &T, h: H, ) -> Result<(), H::HandledErr>

where T: TryStaticCast, C: TryStaticCast, H: EncodeErrorHandler,

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

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: ManagedTypeApi> PartialEq<[u8]> for ManagedBuffer<M>

fn eq(&self, other: &[u8]) -> 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: ManagedTypeApi> PartialEq for ManagedBuffer<M>

fn eq(&self, other: &Self) -> 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: ManagedTypeApi> SCBinary for ManagedBuffer<M>

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

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

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

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

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

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

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<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_max_size_buffer<H, const MAX_LEN: usize>( self, buffer: &mut [u8; MAX_LEN], h: H, ) -> Result<&[u8], H::HandledErr>

where H: DecodeErrorHandler,

👎Deprecated since 0.48.1: Please use method into_max_size_buffer_align_right instead.

Puts the underlying data into a fixed size byte buffer and returns the populated data slice from this buffer.

fn into_max_size_buffer_align_right<H, const MAX_LEN: usize>( self, buffer: &mut [u8; MAX_LEN], h: H, ) -> Result<usize, H::HandledErr>

where H: DecodeErrorHandler,

Puts the underlying data into a fixed size byte buffer, aligned to the right.

fn into_i64<H>(self, h: H) -> Result<i64, H::HandledErr>

where H: DecodeErrorHandler,

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

fn supports_specialized_type<T: TryStaticCast>() -> bool

fn into_specialized<T, H>(self, h: H) -> Result<T, H::HandledErr>

where T: TryStaticCast, H: DecodeErrorHandler,

fn into_nested_buffer(self) -> Self::NestedBuffer

fn into_u64<H>(self, h: H) -> Result<u64, <H as DecodeErrorHandler>::HandledErr>

where H: DecodeErrorHandler,

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

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

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<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 supports_specialized_type<T: TryStaticCast>() -> bool

fn set_specialized<T, H>(self, value: &T, h: H) -> Result<(), H::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.

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)

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>

type Unmanaged = Vec<u8>

fn type_name() -> TypeName

fn type_name_rust() -> TypeName

fn type_names() -> TypeNames

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> Eq for ManagedBuffer<M>

impl<Env> TxCodeValue<Env> for ManagedBuffer<Env::Api>

where Env: TxEnv,

impl<M> TypeAbiFrom<&[u8]> for ManagedBuffer<M>

where M: ManagedTypeApi,

impl<M, const N: usize> TypeAbiFrom<&[u8; N]> for ManagedBuffer<M>

where M: ManagedTypeApi,

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

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

impl<M> TypeAbiFrom<&ManagedBuffer<M>> for ManagedBuffer<M>

where M: ManagedTypeApi,

impl<M: ManagedTypeApi> TypeAbiFrom<&ManagedBuffer<M>> for String

impl<M: ManagedTypeApi> TypeAbiFrom<&ManagedBuffer<M>> for Vec<u8>

impl<M: ManagedTypeApi> TypeAbiFrom<&String> for ManagedBuffer<M>

impl<M: ManagedTypeApi> TypeAbiFrom<&Vec<u8>> for ManagedBuffer<M>

impl<M> TypeAbiFrom<&str> for ManagedBuffer<M>

where M: ManagedTypeApi,

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

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

impl<M> TypeAbiFrom<ManagedBuffer<M>> for ManagedBuffer<M>

where M: ManagedTypeApi,

impl<M: ManagedTypeApi> TypeAbiFrom<ManagedBuffer<M>> for String

impl<M: ManagedTypeApi> TypeAbiFrom<ManagedBuffer<M>> for Vec<u8>

impl<M: ManagedTypeApi> TypeAbiFrom<OperationCompletionStatus> for ManagedBuffer<M>

impl<M: ManagedTypeApi> TypeAbiFrom<String> for ManagedBuffer<M>

impl<M: ManagedTypeApi> TypeAbiFrom<Vec<u8>> for ManagedBuffer<M>