Struct ListCheckpointsRequest 

#[non_exhaustive]
pub struct ListCheckpointsRequest {
    pub read_mask: Option<FieldMask>,
    pub start_checkpoint: Option<u64>,
    pub end_checkpoint: Option<u64>,
    pub filter: Option<TransactionFilter>,
    pub options: Option<QueryOptions>,
}

Available on crate feature unstable only.

Request message for LedgerService.ListCheckpoints.

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.

read_mask: Option<FieldMask>

Optional. Mask for specifying which parts of the Checkpoint should be returned (e.g. summary, contents, signatures).

start_checkpoint: Option<u64>

Optional. Start of the checkpoint range to query (inclusive). Defaults to genesis.

end_checkpoint: Option<u64>

Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.

filter: Option<TransactionFilter>

Optional. DNF filter over indexed transaction dimensions. A checkpoint matches if any transaction it contains satisfies the filter. If absent, all checkpoints in the range are returned.

options: Option<QueryOptions>

Optional cursor-bounded query options. If unspecified, reads in ascending order with the default item limit. The server enforces a maximum item limit and silently coerces larger values down to it. To paginate, track the latest Watermark.cursor received — from either a standalone Watermark frame or the watermark field on an item — and pass it as options.after (ascending) or options.before (descending) on the next request.

Implementations

impl ListCheckpointsRequest

pub const READ_MASK_FIELD: &'static MessageField

pub const START_CHECKPOINT_FIELD: &'static MessageField

pub const END_CHECKPOINT_FIELD: &'static MessageField

pub const FILTER_FIELD: &'static MessageField

pub const OPTIONS_FIELD: &'static MessageField

impl ListCheckpointsRequest

pub fn path_builder() -> ListCheckpointsRequestFieldPathBuilder

impl ListCheckpointsRequest

pub const fn const_default() -> Self

pub fn read_mask_opt_mut(&mut self) -> Option<&mut FieldMask>

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

pub fn read_mask_mut(&mut self) -> &mut FieldMask

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

pub fn read_mask_opt(&self) -> Option<&FieldMask>

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

pub fn set_read_mask<T: Into<FieldMask>>(&mut self, field: T)

Sets read_mask with the provided value.

pub fn with_read_mask<T: Into<FieldMask>>(self, field: T) -> Self

Sets read_mask with the provided value.

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

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

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

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

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

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

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

Sets start_checkpoint with the provided value.

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

Sets start_checkpoint with the provided value.

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

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

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

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

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

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

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

Sets end_checkpoint with the provided value.

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

Sets end_checkpoint with the provided value.

pub fn filter(&self) -> &TransactionFilter

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

pub fn filter_opt_mut(&mut self) -> Option<&mut TransactionFilter>

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

pub fn filter_mut(&mut self) -> &mut TransactionFilter

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

pub fn filter_opt(&self) -> Option<&TransactionFilter>

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

pub fn set_filter<T: Into<TransactionFilter>>(&mut self, field: T)

Sets filter with the provided value.

pub fn with_filter<T: Into<TransactionFilter>>(self, field: T) -> Self

Sets filter with the provided value.

pub fn options(&self) -> &QueryOptions

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

pub fn options_opt_mut(&mut self) -> Option<&mut QueryOptions>

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

pub fn options_mut(&mut self) -> &mut QueryOptions

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

pub fn options_opt(&self) -> Option<&QueryOptions>

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

pub fn set_options<T: Into<QueryOptions>>(&mut self, field: T)

Sets options with the provided value.

pub fn with_options<T: Into<QueryOptions>>(self, field: T) -> Self

Sets options with the provided value.

impl ListCheckpointsRequest

pub fn start_checkpoint(&self) -> u64

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

pub fn end_checkpoint(&self) -> u64

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

Trait Implementations

impl Clone for ListCheckpointsRequest

fn clone(&self) -> ListCheckpointsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListCheckpointsRequest

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

Formats the value using the given formatter.

impl Default for ListCheckpointsRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListCheckpointsRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListCheckpointsRequest

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 ListCheckpointsRequest

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

impl PartialEq for ListCheckpointsRequest

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

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 ListCheckpointsRequest