Struct ImageQuery

pub struct ImageQuery { /* private fields */ }

A query to image list.

Implementations

impl ImageQuery

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

Add sorting to the request.

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 with_name<T: Into<String>>(self, value: T) -> Self

Filter by image name.

pub fn with_status<T: Into<ImageStatus>>(self, value: T) -> Self

Filter by image status.

pub fn with_visibility<T: Into<ImageVisibility>>(self, value: T) -> Self

Filter by visibility.

pub fn into_stream( self, ) -> impl Stream<Item = Result<<ImageQuery as ResourceQuery>::Item>>

Convert this query into a 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<Image>>

Execute this request and return all results.

A convenience shortcut for self.into_stream().try_collect().await.

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

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 ImageQuery

fn clone(&self) -> ImageQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageQuery

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

Formats the value using the given formatter.

impl ResourceQuery for ImageQuery

const DEFAULT_LIMIT: usize = 50usize

Default limit to use with this query.

type Item = Image

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.