Struct RouterQuery 

pub struct RouterQuery { /* private fields */ }

A query to router list.

Implementations

impl RouterQuery

pub fn with_marker<T: Into<String>>(self, marker: T) -> Self

Add marker to the request.

Using this disables automatic pagination.

pub fn with_limit(self, limit: usize) -> Self

Add limit to the request.

Using this disables automatic pagination.

pub fn sort_by(self, sort: Sort<RouterSortKey>) -> Self

Add sorting to the request.

pub fn with_name<T: Into<String>>(self, value: T) -> Self

Filter by router name (a database regular expression).

pub fn into_stream(self) -> impl Stream<Item = Result<Router>>

Convert this query into an stream executing the request.

Returns a TryStream, which is a stream with each next call returning a Result.

Note that no requests are done until you start iterating.

pub async fn all(self) -> Result<Vec<Router>>

Execute this request and return all results.

A convenience shortcut for self.into_iter().collect().

pub async fn one(self) -> Result<Router>

Return one and exactly one result.

Fails with ResourceNotFound if the query produces no results and with TooManyItems if the query produces more than one result.

Trait Implementations

impl Clone for RouterQuery

fn clone(&self) -> RouterQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouterQuery

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

Formats the value using the given formatter.

impl ResourceQuery for RouterQuery

const DEFAULT_LIMIT: usize = 50usize

Default limit to use with this query.

type Item = Router

Item type.

fn can_paginate<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Whether pagination is supported for this query.

fn extract_marker(&self, resource: &Self::Item) -> String

Extract a marker from a resource.

fn fetch_chunk<'life0, 'async_trait>( &'life0 self, limit: Option<usize>, marker: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::Item>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a chunk of resources.

fn validate<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait,

Validate the query before the first execution.