Struct GetUpdatesPageRequest 

pub struct GetUpdatesPageRequest {
    pub begin_offset_exclusive: Option<i64>,
    pub end_offset_inclusive: Option<i64>,
    pub max_page_size: Option<i32>,
    pub update_format: Option<UpdateFormat>,
    pub descending_order: bool,
    pub page_token: Option<Vec<u8>>,
}

Fields

begin_offset_exclusive: Option<i64>

Exclusive lower bound offset of the requested ledger section (non-negative integer). The response page will only contain updates whose offset is strictly greater than this. If set to zero or not defined, the lower bound is set to the actual pruning offset or to the beginning of the ledger if the participant was not pruned yet. If set to positive and the ledger has been pruned, this parameter must be greater or equal than the pruning offset.

Optional

end_offset_inclusive: Option<i64>

Inclusive upper bound offset of the requested ledger section. If specified the response will only contain updates whose offset is less than or equal to this. If not specified response will only contain updates whose offset is less than the current ledger-end.

Optional

max_page_size: Option<i32>

The result page will contain the first max_page_size Updates of all matching updates. The server may reject queries with max_page_size above server specified limits. If not specified, the default max_page_size is determined by the server.

Optional

update_format: Option<UpdateFormat>

Required

descending_order: bool

If set, the page will populate the elements in descending order starting from the end_offset_inclusive.

Optional

page_token: Option<Vec<u8>>

To get the next page of updates, the page_token should be set to the next_page_token of the last GetUpdatesPageResponse. To achieve correct paging: subsequent requests must

• be executed on the same participant,
• have the same begin_offset_exclusive,
• have the same end_offset_inclusive,
• have the same update_format and
• have the same descending_order.

If not specified, the first page of updates will be returned.

Optional: can be empty

Implementations

impl GetUpdatesPageRequest

pub fn begin_offset_exclusive(&self) -> i64

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

pub fn end_offset_inclusive(&self) -> i64

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

pub fn max_page_size(&self) -> i32

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

pub fn page_token(&self) -> &[u8]

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

Trait Implementations

impl Clone for GetUpdatesPageRequest

fn clone(&self) -> GetUpdatesPageRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetUpdatesPageRequest

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

Formats the value using the given formatter.

impl Default for GetUpdatesPageRequest

fn default() -> GetUpdatesPageRequest

Returns the “default value” for a type.

impl Message for GetUpdatesPageRequest

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 PartialEq for GetUpdatesPageRequest

fn eq(&self, other: &GetUpdatesPageRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GetUpdatesPageRequest