Struct SubscribeCheckpointsResponse 

#[non_exhaustive]
pub struct SubscribeCheckpointsResponse {
    pub cursor: Option<u64>,
    pub checkpoint: Option<Checkpoint>,
}

Response message for SubscriptionService.SubscribeCheckpoints.

A checkpoint stream’s position is checkpoint-granular, so the cursor sequence number stands in for the Watermark message the other subscription responses carry. Progress-only frames (with checkpoint unset) occur only on filtered streams: on an unfiltered stream every frame carries both fields, in order and without gaps.

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.

cursor: Option<u64>

Required. The checkpoint sequence number the stream has fully covered, inclusive: every matching checkpoint from the stream’s start position through cursor has been delivered. Present on every frame and advances monotonically.

checkpoint: Option<Checkpoint>

The matching checkpoint. Unset when this frame only advances the cursor past non-matching checkpoints.

Implementations

impl SubscribeCheckpointsResponse

pub const CURSOR_FIELD: &'static MessageField

pub const CHECKPOINT_FIELD: &'static MessageField

impl SubscribeCheckpointsResponse

pub fn path_builder() -> SubscribeCheckpointsResponseFieldPathBuilder

impl SubscribeCheckpointsResponse

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets cursor with the provided value.

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

Sets cursor with the provided value.

pub fn checkpoint(&self) -> &Checkpoint

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

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

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

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

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<&Checkpoint>

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

pub fn set_checkpoint<T: Into<Checkpoint>>(&mut self, field: T)

Sets checkpoint with the provided value.

pub fn with_checkpoint<T: Into<Checkpoint>>(self, field: T) -> Self

Sets checkpoint with the provided value.

impl SubscribeCheckpointsResponse

pub fn cursor(&self) -> u64

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

Trait Implementations

impl Clone for SubscribeCheckpointsResponse

fn clone(&self) -> SubscribeCheckpointsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeCheckpointsResponse

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

Formats the value using the given formatter.

impl Default for SubscribeCheckpointsResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeCheckpointsResponse

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SubscribeCheckpointsResponse

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 SubscribeCheckpointsResponse

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

impl PartialEq for SubscribeCheckpointsResponse

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

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 SubscribeCheckpointsResponse