Struct KeysQuery

pub struct KeysQuery {
    pub offset: Option<usize>,
    pub limit: Option<usize>,
}

Fields

offset: Option<usize>

The number of documents to skip.

If the value of the parameter offset is n, the n first documents (ordered by relevance) will not be returned. This is helpful for pagination.

Example: If you want to skip the first document, set offset to 1.

limit: Option<usize>

The maximum number of documents returned.

If the value of the parameter limit is n, there will never be more than n documents in the response. This is helpful for pagination.

Example: If you don’t want to get more than two documents, set limit to 2.

Default: 20

Implementations

impl KeysQuery

pub fn new() -> KeysQuery

Create a KeysQuery with only a description.

Example

let builder = KeysQuery::new();

pub fn with_offset(&mut self, offset: usize) -> &mut KeysQuery

Specify the offset.

Example

let mut keys = KeysQuery::new()
    .with_offset(1)
    .execute(&client).await.unwrap();

assert_eq!(keys.offset, 1);

pub fn with_limit(&mut self, limit: usize) -> &mut KeysQuery

Specify the maximum number of keys to return.

Example

let mut keys = KeysQuery::new()
    .with_limit(1)
    .execute(&client).await.unwrap();

assert_eq!(keys.results.len(), 1);

pub async fn execute<Http: HttpClient>( &self, client: &Client<Http>, ) -> Result<KeysResults, Error>

Get Key’s.

Example

let mut keys = KeysQuery::new()
    .with_limit(1)
    .execute(&client).await.unwrap();

assert_eq!(keys.results.len(), 1);

Trait Implementations

impl Clone for KeysQuery

fn clone(&self) -> KeysQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeysQuery

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

Formats the value using the given formatter.

impl Default for KeysQuery

fn default() -> KeysQuery

Returns the “default value” for a type.

impl Serialize for KeysQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.