multiversx_sc_snippets::imports::heap

Struct Address

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

Expand description

An Address is just a H256 with a different name. Has a different ABI name than H256.

Note: we are currently using ManagedAddress in contracts. While this also works, its use in contracts is discouraged.

Implementations§

impl Address

pub const fn new(bytes: [u8; 32]) -> Address

pub fn generate_mock_address( creator_address: &[u8], creator_nonce: u64, ) -> Address

impl Address

pub fn from_slice(slice: &[u8]) -> Address

impl Address

pub fn zero() -> Address

Returns a new address of 32 zeros. Allocates directly in heap. Minimal resulting wasm code (14 bytes if not inlined).

pub fn len_bytes() -> usize

Returns the size of an address in bytes.

pub fn as_bytes(&self) -> &[u8] ⓘ

Extracts a byte slice containing the entire fixed hash.

pub fn as_array(&self) -> &[u8; 32]

pub fn copy_to_array(&self, target: &mut [u8; 32])

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

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

Pointer to the data on the heap.

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

Returns an unsafe mutable pointer to the data on the heap. Used by the API to populate data.

pub fn is_zero(&self) -> bool

True if all 32 bytes of the hash are zero.

pub fn is_smart_contract_address(&self) -> bool

Trait Implementations§

impl<Env> AnnotatedValue<Env, ManagedAddress<<Env as TxEnv>::Api>> for &Address
where Env: TxEnv,

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

fn to_value(&self, _env: &Env) -> ManagedAddress<<Env as TxEnv>::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. Read more

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

impl<Env> AnnotatedValue<Env, ManagedAddress<<Env as TxEnv>::Api>> for Address
where Env: TxEnv,

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

fn to_value(&self, _env: &Env) -> ManagedAddress<<Env as TxEnv>::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. Read more

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

impl AsMut<[u8]> for Address

fn as_mut(&mut self) -> &mut [u8] ⓘ

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

impl AsRef<[u8]> for Address

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

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

impl Clone for Address

fn clone(&self) -> Address

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 Address

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

Formats the value using the given formatter. Read more

impl<'a> From<&'a [u8; 32]> for Address

fn from(bytes: &'a [u8; 32]) -> Address

Converts to this type from the input type.

impl<'a> From<&'a Address> for &'a H256

fn from(address: &'a Address) -> &'a H256

Converts to this type from the input type.

impl From<&Address> for AddressValue

fn from(from: &Address) -> AddressValue

Converts to this type from the input type.

impl From<&Address> for Bech32Address

fn from(value: &Address) -> Bech32Address

Converts to this type from the input type.

impl<M> From<&Address> for ManagedAddress<M>
where M: ManagedTypeApi,

fn from(address: &Address) -> ManagedAddress<M>

Converts to this type from the input type.

impl<'a> From<&'a mut [u8; 32]> for Address

fn from(bytes: &'a mut [u8; 32]) -> Address

Converts to this type from the input type.

impl From<[u8; 32]> for Address

fn from(arr: [u8; 32]) -> Address

Converts to this type from the input type.

impl From<Address> for Bech32Address

fn from(value: Address) -> Bech32Address

Converts to this type from the input type.

impl From<Address> for H256

fn from(address: Address) -> H256

Converts to this type from the input type.

impl<M> From<Address> for ManagedAddress<M>
where M: ManagedTypeApi,

fn from(address: Address) -> ManagedAddress<M>

Converts to this type from the input type.

impl From<Box<[u8; 32]>> for Address

fn from(bytes: Box<[u8; 32]>) -> Address

Converts to this type from the input type.

impl From<H256> for Address

fn from(hash: H256) -> Address

Converts to this type from the input type.

impl From<SdkAddress> for Address

fn from(value: SdkAddress) -> Address

Converts to this type from the input type.

impl Hash for Address

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl NestedDecode for Address

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Address, <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 Address

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<Address> for TestAddress<'_>

fn eq(&self, other: &Address) -> 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 PartialEq<Address> for TestSCAddress<'_>

fn eq(&self, other: &Address) -> 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<'a> PartialEq<TestAddress<'a>> for Address

fn eq(&self, other: &TestAddress<'a>) -> 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<'a> PartialEq<TestSCAddress<'a>> for Address

fn eq(&self, other: &TestSCAddress<'a>) -> 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 PartialEq for Address

fn eq(&self, other: &Address) -> 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 Address

fn top_decode_or_handle_err<I, H>( input: I, h: H, ) -> Result<Address, <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 Address

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<Env> TxFrom<Env> for &Address
where Env: TxEnv,

fn resolve_address(&self, _env: &Env) -> ManagedAddress<<Env as TxEnv>::Api>

impl<Env> TxFrom<Env> for Address
where Env: TxEnv,

fn resolve_address(&self, _env: &Env) -> ManagedAddress<<Env as TxEnv>::Api>

impl<Env> TxToSpecified<Env> for &Address
where Env: TxEnv,

fn with_address_ref<F, R>(&self, env: &Env, f: F) -> R
where F: FnOnce(&ManagedAddress<<Env as TxEnv>::Api>) -> R,

Avoids a clone when performing transfer-execute. Read more

impl<Env> TxToSpecified<Env> for Address
where Env: TxEnv,

fn with_address_ref<F, R>(&self, env: &Env, f: F) -> R
where F: FnOnce(&ManagedAddress<<Env as TxEnv>::Api>) -> R,

Avoids a clone when performing transfer-execute. Read more

impl TypeAbi for Address

type Unmanaged = Address

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 Address

impl StructuralPartialEq for Address

impl<Env> TxFromSpecified<Env> for &Address
where Env: TxEnv,

impl<Env> TxFromSpecified<Env> for Address
where Env: TxEnv,

impl<Env> TxTo<Env> for &Address
where Env: TxEnv,

impl<Env> TxTo<Env> for Address
where Env: TxEnv,

impl<M> TypeAbiFrom<&Address> for ManagedAddress<M>
where M: ManagedTypeApi,

impl<P> TypeAbiFrom<&ContractInfo<P>> for Address
where P: ProxyObjNew,

impl<M> TypeAbiFrom<&ManagedAddress<M>> for Address
where M: ManagedTypeApi,

impl TypeAbiFrom<Address> for Address

impl<M> TypeAbiFrom<Address> for ManagedAddress<M>
where M: ManagedTypeApi,

impl<P> TypeAbiFrom<ContractInfo<P>> for Address
where P: ProxyObjNew,

impl<M> TypeAbiFrom<ManagedAddress<M>> for Address
where M: ManagedTypeApi,

Auto Trait Implementations§

impl Freeze for Address

impl RefUnwindSafe for Address

impl Send for Address

impl Sync for Address

impl Unpin for Address

impl UnwindSafe for Address

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,