Struct meilisearch_sdk::indexes::IndexesQuery

pub struct IndexesQuery<'a> {
    pub client: &'a Client,
    pub offset: Option<usize>,
    pub limit: Option<usize>,
}

An IndexesQuery containing filter and pagination parameters when searching for Indexes.

Example

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

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

Fields

client: &'a Client

offset: Option<usize>

The number of Indexes to skip.

If the value of the parameter offset is n, the n first indexes will not be returned. This is helpful for pagination.

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

limit: Option<usize>

The maximum number of Indexes returned.

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

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

Default: 20

Implementations

impl<'a> IndexesQuery<'a>

pub fn new(client: &Client) -> IndexesQuery<'_>

pub fn with_offset(&mut self, offset: usize) -> &mut IndexesQuery<'a>

Specify the offset.

Example

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

assert_eq!(indexes.offset, 1);

pub fn with_limit(&mut self, limit: usize) -> &mut IndexesQuery<'a>

Specify the maximum number of Indexes to return.

Example

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

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

pub async fn execute(&self) -> Result<IndexesResults, Error>

Get Indexes.

Example

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

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

Trait Implementations

impl<'a> Clone for IndexesQuery<'a>

fn clone(&self) -> IndexesQuery<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IndexesQuery<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for IndexesQuery<'a>

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

Serialize this value into the given Serde serializer.