Struct ListRecordsQuery 

pub struct ListRecordsQuery {
    pub repo: String,
    pub collection: String,
    pub limit: Option<usize>,
    pub cursor: Option<String>,
    pub reverse: Option<bool>,
}

Query of com.atproto.repo.listRecords.

Fields

repo: String

The repository to read, as a DID or a handle.

collection: String

The collection NSID to list.

limit: Option<usize>

How many records to return.

cursor: Option<String>

The record key a previous page ended on, resumed after.

reverse: Option<bool>

Read oldest first rather than newest first.

Implementations

impl ListRecordsQuery

pub fn effective_limit(&self) -> usize

The limit to apply, defaulting when the caller did not choose one.

A limit of zero is honoured rather than treated as unset: a caller asking for no records is asking a question about existence, and answering it with fifty records would be answering a different one. The lexicon’s minimum is one, so a conformant client cannot ask it anyway.

pub fn page(&self) -> ListParams

The page this query asks the store for.

The cursor is passed through as the record key it is. It is not decoded, checked or signed: it names a position in public data the same request would have reached anyway, and a cursor naming a key that is not there is not an error — it is where to carry on from, which is what makes a page survive the deletion of the row it resumed after.

Trait Implementations

impl Clone for ListRecordsQuery

fn clone(&self) -> ListRecordsQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListRecordsQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ListRecordsQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ListRecordsQuery

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ListRecordsQuery

impl StructuralPartialEq for ListRecordsQuery