Struct PageRequest

pub struct PageRequest {
    pub key: Vec<u8>,
    pub offset: u64,
    pub limit: u64,
    pub count_total: bool,
    pub reverse: bool,
}

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest { Foo some_parameter = 1; PageRequest pagination = 2; }

Fields

key: Vec<u8>

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

offset: u64

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

limit: u64

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

count_total: bool

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

reverse: bool

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Implementations

impl PageRequest

pub const TYPE_URL: &'static str = "/cosmos.base.query.v1beta1.PageRequest"

pub fn to_proto_bytes(&self) -> Vec<u8>

pub fn to_any(&self) -> Any

Trait Implementations

impl Clone for PageRequest

fn clone(&self) -> PageRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageRequest

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

Formats the value using the given formatter.

impl Default for PageRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PageRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PageRequest> for Binary

fn from(msg: PageRequest) -> Self

Converts to this type from the input type.

impl<T> From<PageRequest> for CosmosMsg<T>

fn from(msg: PageRequest) -> Self

Converts to this type from the input type.

impl JsonSchema for PageRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Message for PageRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PageRequest

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Binary> for PageRequest

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(binary: Binary) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SubMsgResult> for PageRequest

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(result: SubMsgResult) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PageRequest

impl StructuralPartialEq for PageRequest