Struct gear_core::message::MessageContext

pub struct MessageContext { /* private fields */ }

Context of currently processing incoming message.

Implementations

impl MessageContext

pub fn new( dispatch: IncomingDispatch, program_id: ProgramId, settings: ContextSettings ) -> Self

Create new MessageContext with given ContextSettings.

pub fn settings(&self) -> &ContextSettings

Getter for inner settings.

pub fn reply_sent(&self) -> bool

Return bool defining was reply sent within the execution.

pub fn init_program( &mut self, packet: InitPacket, delay: u32 ) -> Result<(MessageId, ProgramId), Error>

Send a new program initialization message.

Generates a new message from provided data packet. Returns message id and generated program id.

pub fn send_commit( &mut self, handle: u32, packet: HandlePacket, delay: u32, reservation: Option<ReservationId> ) -> Result<MessageId, Error>

Send a new program initialization message.

Generates message from provided data packet and stored by handle payload. Returns message id.

pub fn send_init(&mut self) -> Result<u32, Error>

Provide space for storing payload for future message creation.

Returns it’s handle.

pub fn send_push(&mut self, handle: u32, buffer: &[u8]) -> Result<(), Error>

Pushes payload into stored payload by handle.

pub fn send_push_input( &mut self, handle: u32, range: CheckedRange ) -> Result<(), Error>

Pushes the incoming buffer/payload into stored payload by handle.

pub fn check_input_range(&self, offset: u32, len: u32) -> CheckedRange

Check if provided offset/len are correct for the current payload limits. Result CheckedRange instance is accepted by send_push_input/reply_push_input and has the method len allowing to charge gas before the calls.

pub fn reply_commit( &mut self, packet: ReplyPacket, reservation: Option<ReservationId> ) -> Result<MessageId, ExtError>

Send reply message.

Generates reply from provided data packet and stored reply payload. Returns message id.

pub fn reply_push(&mut self, buffer: &[u8]) -> Result<(), ExtError>

Pushes payload into stored reply payload.

pub fn reply_destination(&self) -> ProgramId

Return reply destination.

pub fn reply_push_input(&mut self, range: CheckedRange) -> Result<(), ExtError>

Pushes the incoming message buffer into stored reply payload.

pub fn wake(&mut self, waker_id: MessageId, delay: u32) -> Result<(), Error>

Wake message by it’s message id.

pub fn reply_deposit( &mut self, message_id: MessageId, amount: u64 ) -> Result<(), MessageError>

Create deposit to handle future reply on message id was sent.

pub fn current(&self) -> &IncomingMessage

Current processing incoming message.

pub fn payload_mut(&mut self) -> &mut Payload

Mutable reference to currently processed incoming message.

pub fn program_id(&self) -> ProgramId

Current program’s id.

pub fn drain(self) -> (ContextOutcome, ContextStore)

Destructs context after execution and returns provided outcome and store.

Trait Implementations

impl Debug for MessageContext

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

Formats the value using the given formatter.

impl Decode for MessageContext

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

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 Encode for MessageContext

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

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<R, F>(&self, f: F) -> R

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

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl Hash for MessageContext

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

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 Ord for MessageContext

fn cmp(&self, other: &MessageContext) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MessageContext

fn eq(&self, other: &MessageContext) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MessageContext

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TypeInfo for MessageContext

type Identity = MessageContext

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for MessageContext

impl Eq for MessageContext

impl StructuralEq for MessageContext

impl StructuralPartialEq for MessageContext