Struct ListCheckpointsResponse 

#[non_exhaustive]
pub struct ListCheckpointsResponse {
    pub checkpoint: Option<Checkpoint>,
    pub watermark: Option<Watermark>,
    pub end: Option<QueryEnd>,
}

Response message for LedgerService.ListCheckpoints.

Every frame carries a watermark with a safe resume cursor. A frame with checkpoint set delivers one matching item; a frame without it reports scan progress or terminal completion. Watermarks never regress in the requested ordering but may repeat.

end is set exactly once, on the final frame of a successful stream. For QUERY_END_REASON_ITEM_LIMIT, that frame also carries the final item. For every other end reason, the final frame has no checkpoint payload.

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.

checkpoint: Option<Checkpoint>

One matching checkpoint.

watermark: Option<Watermark>

Progress watermark as of this frame. Present on every frame. A ScanLimit terminal watermark may repeat the previous frame’s cursor when its authoritative scan frontier was already emitted.

end: Option<QueryEnd>

Set exactly once, on the final frame of a successful query stream.

Implementations

impl ListCheckpointsResponse

pub const CHECKPOINT_FIELD: &'static MessageField

pub const WATERMARK_FIELD: &'static MessageField

pub const END_FIELD: &'static MessageField

impl ListCheckpointsResponse

pub fn path_builder() -> ListCheckpointsResponseFieldPathBuilder

impl ListCheckpointsResponse

pub const fn const_default() -> Self

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.

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 end(&self) -> &QueryEnd

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

pub fn end_opt_mut(&mut self) -> Option<&mut QueryEnd>

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

pub fn end_mut(&mut self) -> &mut QueryEnd

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

pub fn end_opt(&self) -> Option<&QueryEnd>

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

pub fn set_end<T: Into<QueryEnd>>(&mut self, field: T)

Sets end with the provided value.

pub fn with_end<T: Into<QueryEnd>>(self, field: T) -> Self

Sets end with the provided value.

Trait Implementations

impl Clone for ListCheckpointsResponse

fn clone(&self) -> ListCheckpointsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListCheckpointsResponse

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

Formats the value using the given formatter.

impl Default for ListCheckpointsResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListCheckpointsResponse

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListCheckpointsResponse

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 ListCheckpointsResponse

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

impl PartialEq for ListCheckpointsResponse

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

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 ListCheckpointsResponse