Struct Event 

#[non_exhaustive]
pub struct Event {
    pub bcs: Option<BcsData>,
    pub package_id: Option<ObjectId>,
    pub module: Option<String>,
    pub sender: Option<Address>,
    pub event_type: Option<String>,
    pub bcs_contents: Option<BcsData>,
    pub json_contents: Option<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.

bcs: Option<BcsData>

This Event serialized as BCS.

package_id: Option<ObjectId>

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

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

event_type: Option<String>

The type of the event emitted.

bcs_contents: Option<BcsData>

BCS serialized bytes of the event.

json_contents: Option<Value>

JSON rendering of the event.

Implementations

impl Event

pub const BCS_FIELD: &'static MessageField

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 BCS_CONTENTS_FIELD: &'static MessageField

pub const JSON_CONTENTS_FIELD: &'static MessageField

impl Event

pub fn path_builder() -> EventFieldPathBuilder

impl Event

pub fn with_bcs<T: Into<BcsData>>(self, field: T) -> Self

Sets bcs with the provided value.

pub fn with_package_id<T: Into<ObjectId>>(self, field: T) -> Self

Sets package_id with the provided value.

pub fn with_module<T: Into<String>>(self, field: T) -> Self

Sets module with the provided value.

pub fn with_sender<T: Into<Address>>(self, field: T) -> Self

Sets sender with the provided value.

pub fn with_event_type<T: Into<String>>(self, field: T) -> Self

Sets event_type with the provided value.

pub fn with_bcs_contents<T: Into<BcsData>>(self, field: T) -> Self

Sets bcs_contents with the provided value.

pub fn with_json_contents<T: Into<Value>>(self, field: T) -> Self

Sets json_contents with the provided value.

impl Event

pub fn module(&self) -> &str

Returns the value of module, or the default value if module 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 fn event(&self) -> Result<Event, TryFromProtoError>

Deserialize the full event from BCS.

Read mask: bcs relative to this event (see EVENT_BCS). Full path depends on context — e.g. "events.bcs" for checkpoint top-level events, "events.events.bcs" for transaction events.

pub fn package_id(&self) -> Result<ObjectId, TryFromProtoError>

Get the package ID of the Move module that emitted this event.

Read mask: package_id relative to this event (see EVENT_PACKAGE_ID).

pub fn module_name(&self) -> Result<Identifier, TryFromProtoError>

Get the module name of the Move module that emitted this event.

Read mask: module relative to this event (see EVENT_MODULE).

pub fn sender(&self) -> Result<Address, TryFromProtoError>

Get the sender address of the transaction that emitted this event.

Read mask: sender relative to this event (see EVENT_SENDER).

pub fn type_name(&self) -> Result<StructTag, TryFromProtoError>

Get the type of the event emitted.

Read mask: event_type relative to this event (see EVENT_TYPE).

pub fn bcs_contents(&self) -> Result<&[u8], TryFromProtoError>

Get the raw BCS bytes of the event contents/data only.

This is the serialized event data without the metadata (package, module, sender, type).

Read mask: bcs_contents relative to this event (see EVENT_BCS_CONTENTS).

pub fn json_contents(&self) -> Result<Value, TryFromProtoError>

Get the JSON contents of the event.

Read mask: json_contents relative to this event (see EVENT_JSON_CONTENTS).

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

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]

const ONEOFS: &'static [&'static str] = _

Oneof group names declared in this message.

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 TryFrom<&Event> for Event

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &Event) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Event