Struct SubscribeEventsResponse 

#[non_exhaustive]
pub struct SubscribeEventsResponse {
    pub event: Option<Event>,
    pub watermark: Option<Watermark>,
}

Response message for SubscriptionService.SubscribeEvents.

Mirrors ListEventsResponse, except there is no end field: a subscription stream has no successful end.

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.

event: Option<Event>

One matching event. Its ledger position – containing checkpoint, emitting transaction digest and offset, and index within that transaction’s event list – is reported by the corresponding fields on Event.

watermark: Option<Watermark>

Progress watermark as of this frame. Present on every frame.

Implementations

impl SubscribeEventsResponse

pub const EVENT_FIELD: &'static MessageField

pub const WATERMARK_FIELD: &'static MessageField

impl SubscribeEventsResponse

pub fn path_builder() -> SubscribeEventsResponseFieldPathBuilder

impl SubscribeEventsResponse

pub const fn const_default() -> Self

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

Trait Implementations

impl Clone for SubscribeEventsResponse

fn clone(&self) -> SubscribeEventsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeEventsResponse

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

Formats the value using the given formatter.

impl Default for SubscribeEventsResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeEventsResponse

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SubscribeEventsResponse

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 SubscribeEventsResponse

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

impl PartialEq for SubscribeEventsResponse

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscribeEventsResponse