Struct Address

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

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::Api>

fn to_value(&self, _env: &Env) -> ManagedAddress<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, ManagedAddress<<Env as TxEnv>::Api>> for Address

where Env: TxEnv,

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

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

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

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<M> From<&Address> for ManagedAddress<M>

where M: ManagedTypeApi,

fn from(address: &Address) -> Self

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

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 Hash for Address

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

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

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

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

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::Api>

impl<Env> TxFrom<Env> for Address

where Env: TxEnv,

fn resolve_address(&self, _env: &Env) -> ManagedAddress<Env::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::Api>) -> R,

Avoids a clone when performing transfer-execute.

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::Api>) -> R,

Avoids a clone when performing transfer-execute.

impl TypeAbi for Address

type Unmanaged = Address

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 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<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<M> TypeAbiFrom<ManagedAddress<M>> for Address

where M: ManagedTypeApi,