Struct openstack::object_storage::ObjectQuery

[+] Show declaration

pub struct ObjectQuery { /* fields omitted */ }

[−] Expand description

A query to objects.

Implementations

impl ObjectQuery[−]

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 into_iter(self) -> ResourceIterator<ObjectQuery>[−]

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<Object>>[−]

Execute this request and return all results.

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

pub fn one(self) -> Result<Object>[−]

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 ObjectQuery[+]

[+] Show hidden undocumented items

fn clone(&self) -> ObjectQuery[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for ObjectQuery[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl IntoFallibleIterator for ObjectQuery[+]

[+] Show hidden undocumented items

type Item = Object

The elements of the iterator.

type Error = Error

The error value of the iterator.

type IntoFallibleIter = ResourceIterator<ObjectQuery>

The iterator.

fn into_fallible_iter(self) -> Self::IntoFallibleIter[−]

Creates a fallible iterator from a value.

impl ResourceQuery for ObjectQuery[+]

[+] Show hidden undocumented items

type Item = Object

Item type.

const DEFAULT_LIMIT: usize[−][−]

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.