Struct MessageId

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

Message identifier.

Gear allows users and program interactions via messages. Each message has its own unique 256-bit id. This id is represented via the MessageId struct. The message identifier can be obtained for the currently processed message using the gstd::msg::id() function. Also, each send and reply functions return a message identifier.

Implementations

impl MessageId

pub const fn new(array: [u8; 32]) -> MessageId

Creates a new MessageId from a 32-byte array.

impl MessageId

pub const fn zero() -> MessageId

Creates a new zero MessageId.

pub fn is_zero(&self) -> bool

Checks whether MessageId is zero.

impl MessageId

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

Returns MessageIdas bytes array.

Trait Implementations

impl<__AsMutT> AsMut<__AsMutT> for MessageId

where [u8; 32]: AsMut<__AsMutT>, __AsMutT: ?Sized,

fn as_mut(&mut self) -> &mut __AsMutT

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

impl<__AsRefT> AsRef<__AsRefT> for MessageId

where [u8; 32]: AsRef<__AsRefT>, __AsRefT: ?Sized,

fn as_ref(&self) -> &__AsRefT

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

impl Clone for MessageId

fn clone(&self) -> MessageId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageId

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

Formats the value using the given formatter.

impl Decode for MessageId

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<MessageId, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for MessageId

fn default() -> MessageId

Returns the “default value” for a type.

impl Display for MessageId

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

Formats the value using the given formatter.

impl Encode for MessageId

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

where __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<[u8; 32]> for MessageId

fn from(original: [u8; 32]) -> MessageId

Converts to this type from the input type.

impl From<H256> for MessageId

fn from(h256: H256) -> MessageId

Converts to this type from the input type.

impl From<u64> for MessageId

fn from(value: u64) -> MessageId

Converts to this type from the input type.

impl FromStr for MessageId

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MessageId, <MessageId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for MessageId

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 MaxEncodedLen for MessageId

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl MessageIdExt for MessageId

fn generate_from_user( block_number: u32, user_id: ProgramId, local_nonce: u128, ) -> MessageId

Generates MessageId for non-program outgoing message.

fn generate_outgoing(origin_msg_id: MessageId, local_nonce: u32) -> MessageId

Generates MessageId for program outgoing message.

fn generate_reply(origin_msg_id: MessageId) -> MessageId

Generates MessageId for reply message depend on status code.

fn generate_signal(origin_msg_id: MessageId) -> MessageId

Generates MessageId for signal message depend on status code.

impl Ord for MessageId

fn cmp(&self, other: &MessageId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MessageId

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

fn partial_cmp(&self, other: &MessageId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeInfo for MessageId

type Identity = MessageId

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for MessageId

impl EncodeLike for MessageId

impl Eq for MessageId

impl StructuralPartialEq for MessageId