Struct EventItem 

#[non_exhaustive]
pub struct EventItem {
    pub watermark: Option<Watermark>,
    pub checkpoint: Option<u64>,
    pub event_index: Option<u32>,
    pub transaction_digest: Option<String>,
    pub event: Option<Event>,
    pub transaction_offset: Option<u64>,
}

Available on crate feature unstable only.

One event item.

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.

watermark: Option<Watermark>

Progress watermark as of when this item was emitted: its cursor is the resume point past this item, and checkpoint_hi / checkpoint_lo (whichever matches the request ordering) is the inclusive boundary checkpoint that the scan has fully covered.

checkpoint: Option<u64>

The checkpoint containing the transaction that emitted this event.

event_index: Option<u32>

The index of this event within the transaction’s event list (0-based).

transaction_digest: Option<String>

The digest of the transaction that emitted this event.

event: Option<Event>

The event data.

transaction_offset: Option<u64>

0-based index of the emitting transaction within its containing checkpoint. Required for clients verifying authenticated event streams: this index is part of the BCS-encoded EventCommitment leaf used to construct the per-checkpoint merkle root.

Implementations

impl EventItem

pub const WATERMARK_FIELD: &'static MessageField

pub const CHECKPOINT_FIELD: &'static MessageField

pub const EVENT_INDEX_FIELD: &'static MessageField

pub const TRANSACTION_DIGEST_FIELD: &'static MessageField

pub const EVENT_FIELD: &'static MessageField

pub const TRANSACTION_OFFSET_FIELD: &'static MessageField

impl EventItem

pub fn path_builder() -> EventItemFieldPathBuilder

impl EventItem

pub const fn const_default() -> Self

pub fn watermark(&self) -> &Watermark

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

pub fn watermark_opt_mut(&mut self) -> Option<&mut Watermark>

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

pub fn watermark_mut(&mut self) -> &mut Watermark

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

pub fn watermark_opt(&self) -> Option<&Watermark>

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

pub fn set_watermark<T: Into<Watermark>>(&mut self, field: T)

Sets watermark with the provided value.

pub fn with_watermark<T: Into<Watermark>>(self, field: T) -> Self

Sets watermark with the provided value.

pub fn checkpoint_opt_mut(&mut self) -> Option<&mut u64>

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

pub fn checkpoint_mut(&mut self) -> &mut u64

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

pub fn checkpoint_opt(&self) -> Option<u64>

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

pub fn set_checkpoint(&mut self, field: u64)

Sets checkpoint with the provided value.

pub fn with_checkpoint(self, field: u64) -> Self

Sets checkpoint with the provided value.

pub fn event_index_opt_mut(&mut self) -> Option<&mut u32>

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

pub fn event_index_mut(&mut self) -> &mut u32

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

pub fn event_index_opt(&self) -> Option<u32>

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

pub fn set_event_index(&mut self, field: u32)

Sets event_index with the provided value.

pub fn with_event_index(self, field: u32) -> Self

Sets event_index with the provided value.

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

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

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

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

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

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

pub fn set_transaction_digest<T: Into<String>>(&mut self, field: T)

Sets transaction_digest with the provided value.

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

Sets transaction_digest with the provided value.

pub fn event(&self) -> &Event

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

pub fn event_opt_mut(&mut self) -> Option<&mut Event>

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

pub fn event_mut(&mut self) -> &mut Event

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

pub fn event_opt(&self) -> Option<&Event>

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

pub fn set_event<T: Into<Event>>(&mut self, field: T)

Sets event with the provided value.

pub fn with_event<T: Into<Event>>(self, field: T) -> Self

Sets event with the provided value.

pub fn transaction_offset_opt_mut(&mut self) -> Option<&mut u64>

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

pub fn transaction_offset_mut(&mut self) -> &mut u64

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

pub fn transaction_offset_opt(&self) -> Option<u64>

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

pub fn set_transaction_offset(&mut self, field: u64)

Sets transaction_offset with the provided value.

pub fn with_transaction_offset(self, field: u64) -> Self

Sets transaction_offset with the provided value.

impl EventItem

pub fn checkpoint(&self) -> u64

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

pub fn event_index(&self) -> u32

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

pub fn transaction_digest(&self) -> &str

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

pub fn transaction_offset(&self) -> u64

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

Trait Implementations

impl Clone for EventItem

fn clone(&self) -> EventItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventItem

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

Formats the value using the given formatter.

impl Default for EventItem

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventItem

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AuthenticatedEvent> for EventItem

fn from(value: &AuthenticatedEvent) -> Self

Converts to this type from the input type.

impl From<AuthenticatedEvent> for EventItem

fn from(value: AuthenticatedEvent) -> Self

Converts to this type from the input type.

impl Message for EventItem

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 EventItem

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

impl PartialEq for EventItem

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&EventItem> for AuthenticatedEvent

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for EventItem