Struct openstack::image::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(self, value: ImageStatus) -> Self

Filter by image status.

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

Filter by visibility.

pub fn into_iter(self) -> ResourceIterator<ImageQuery>

Convert this query into an iterator executing the request.

Returns a FallibleIterator, which is an iterator with each next call returning a Result.

Note that no requests are done until you start iterating.

pub fn all(self) -> Result<Vec<Image>>

Execute this request and return all results.

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

pub 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 IntoFallibleIterator for ImageQuery

type Item = Image

The elements of the iterator.

type Error = Error

The error value of the iterator.

type IntoIter = ResourceIterator<ImageQuery>

The iterator.

fn into_fallible_iterator(self) -> Self::IntoIter

Creates a fallible iterator from a value.

impl ResourceQuery for ImageQuery

type Item = Image

Item type.

const DEFAULT_LIMIT: usize = 50usize

Default limit to use with this query.

fn can_paginate(&self) -> Result<bool>

Whether pagination is supported for this query.

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

Extract a marker from a resource.

fn fetch_chunk(
    &self,
    limit: Option<usize>,
    marker: Option<String>
) -> Result<Vec<Self::Item>>

Get a chunk of resources.

fn validate(&mut self) -> Result<()>

Validate the query before the first execution.