Struct Event

#[non_exhaustive]
pub struct Event {
    pub package_id: Option<String>,
    pub module: Option<String>,
    pub sender: Option<String>,
    pub event_type: Option<String>,
    pub contents: Option<Bcs>,
    pub json: Option<Box<Value>>,
}

An event.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

package_id: Option<String>

Package ID of the top-level function invoked by a MoveCall command that triggered this event to be emitted.

module: Option<String>

Module name of the top-level function invoked by a MoveCall command that triggered this event to be emitted.

sender: Option<String>

Address of the account that sent the transaction where this event was emitted.

event_type: Option<String>

The type of the event emitted.

contents: Option<Bcs>

BCS serialized bytes of the event.

json: Option<Box<Value>>

JSON rendering of the event.

Implementations

impl Event

pub fn package_id(&self) -> &str

Returns the value of package_id, or the default value if package_id is unset.

pub fn module(&self) -> &str

Returns the value of module, or the default value if module is unset.

pub fn sender(&self) -> &str

Returns the value of sender, or the default value if sender is unset.

pub fn event_type(&self) -> &str

Returns the value of event_type, or the default value if event_type is unset.

impl Event

pub const PACKAGE_ID_FIELD: &'static MessageField

pub const MODULE_FIELD: &'static MessageField

pub const SENDER_FIELD: &'static MessageField

pub const EVENT_TYPE_FIELD: &'static MessageField

pub const CONTENTS_FIELD: &'static MessageField

pub const JSON_FIELD: &'static MessageField

impl Event

pub fn path_builder() -> EventFieldPathBuilder

impl Event

pub const fn const_default() -> Event

pub fn package_id_opt_mut(&mut self) -> Option<&mut String>

If package_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn package_id_mut(&mut self) -> &mut String

Returns a mutable reference to package_id. If the field is unset, it is first initialized with the default value.

pub fn package_id_opt(&self) -> Option<&str>

If package_id is set, returns Some with the value; otherwise returns None.

pub fn set_package_id<T>(&mut self, field: T)

where T: Into<String>,

Sets package_id with the provided value.

pub fn with_package_id<T>(self, field: T) -> Event

where T: Into<String>,

Sets package_id with the provided value.

pub fn module_opt_mut(&mut self) -> Option<&mut String>

If module is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn module_mut(&mut self) -> &mut String

Returns a mutable reference to module. If the field is unset, it is first initialized with the default value.

pub fn module_opt(&self) -> Option<&str>

If module is set, returns Some with the value; otherwise returns None.

pub fn set_module<T>(&mut self, field: T)

where T: Into<String>,

Sets module with the provided value.

pub fn with_module<T>(self, field: T) -> Event

where T: Into<String>,

Sets module with the provided value.

pub fn sender_opt_mut(&mut self) -> Option<&mut String>

If sender is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn sender_mut(&mut self) -> &mut String

Returns a mutable reference to sender. If the field is unset, it is first initialized with the default value.

pub fn sender_opt(&self) -> Option<&str>

If sender is set, returns Some with the value; otherwise returns None.

pub fn set_sender<T>(&mut self, field: T)

where T: Into<String>,

Sets sender with the provided value.

pub fn with_sender<T>(self, field: T) -> Event

where T: Into<String>,

Sets sender with the provided value.

pub fn event_type_opt_mut(&mut self) -> Option<&mut String>

If event_type is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn event_type_mut(&mut self) -> &mut String

Returns a mutable reference to event_type. If the field is unset, it is first initialized with the default value.

pub fn event_type_opt(&self) -> Option<&str>

If event_type is set, returns Some with the value; otherwise returns None.

pub fn set_event_type<T>(&mut self, field: T)

where T: Into<String>,

Sets event_type with the provided value.

pub fn with_event_type<T>(self, field: T) -> Event

where T: Into<String>,

Sets event_type with the provided value.

pub fn contents(&self) -> &Bcs

Returns the value of contents, or the default value if contents is unset.

pub fn contents_opt_mut(&mut self) -> Option<&mut Bcs>

If contents is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn contents_mut(&mut self) -> &mut Bcs

Returns a mutable reference to contents. If the field is unset, it is first initialized with the default value.

pub fn contents_opt(&self) -> Option<&Bcs>

If contents is set, returns Some with the value; otherwise returns None.

pub fn set_contents<T>(&mut self, field: T)

where T: Into<Bcs>,

Sets contents with the provided value.

pub fn with_contents<T>(self, field: T) -> Event

where T: Into<Bcs>,

Sets contents with the provided value.

pub fn json_opt_mut(&mut self) -> Option<&mut Value>

If json is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn json_mut(&mut self) -> &mut Value

Returns a mutable reference to json. If the field is unset, it is first initialized with the default value.

pub fn json_opt(&self) -> Option<&Value>

If json is set, returns Some with the value; otherwise returns None.

pub fn set_json<T>(&mut self, field: T)

where T: Into<Value>,

Sets json with the provided value.

pub fn with_json<T>(self, field: T) -> Event

where T: Into<Value>,

Sets json with the provided value.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Event

fn deserialize<D>( deserializer: D, ) -> Result<Event, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Event> for Event

fn from(value: Event) -> Event

Converts to this type from the input type.

impl From<Event> for Event

fn from(value: Event) -> Event

Converts to this type from the input type.

impl Merge<&Event> for Event

fn merge(&mut self, source: &Event, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<Event> for Event

fn merge(&mut self, source: Event, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<Event> for Event

fn merge(&mut self, source: Event, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Message for Event

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Event

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Event

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Event