Struct ServerQuery 

pub struct ServerQuery { /* private fields */ }

A query to server list.

Implementations

impl ServerQuery

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<ServerSortKey>) -> Self

Add sorting to the request.

pub fn all_tenants(self) -> Self

Add all tenants to the request.

pub fn set_access_ip_v4<T: Into<Ipv4Addr>>(&mut self, value: T)

Filter by IPv4 address that should be used to access the server.

pub fn with_access_ip_v4<T: Into<Ipv4Addr>>(self, value: T) -> Self

Filter by IPv4 address that should be used to access the server.

pub fn set_access_ip_v6<T: Into<Ipv6Addr>>(&mut self, value: T)

Filter by IPv6 address that should be used to access the server.

pub fn with_access_ip_v6<T: Into<Ipv6Addr>>(self, value: T) -> Self

Filter by IPv6 address that should be used to access the server.

pub fn set_availability_zone<T: Into<String>>(&mut self, value: T)

Filter by availability zone.

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

Filter by availability zone.

pub fn set_flavor<T: Into<FlavorRef>>(&mut self, value: T)

Filter by flavor.

pub fn with_flavor<T: Into<FlavorRef>>(self, value: T) -> Self

Filter by flavor.

pub fn set_hostname<T: Into<String>>(&mut self, value: T)

Filter by host name.

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

Filter by host name.

pub fn set_image<T: Into<ImageRef>>(&mut self, value: T)

Filter by image used to build the server.

pub fn with_image<T: Into<ImageRef>>(self, value: T) -> Self

Filter by image used to build the server.

pub fn set_ip_v4<T: Into<Ipv4Addr>>(&mut self, value: T)

Filter by an IPv4 address.

pub fn with_ip_v4<T: Into<Ipv4Addr>>(self, value: T) -> Self

Filter by an IPv4 address.

pub fn set_ip_v6<T: Into<Ipv6Addr>>(&mut self, value: T)

Filter by an IPv6 address.

pub fn with_ip_v6<T: Into<Ipv6Addr>>(self, value: T) -> Self

Filter by an IPv6 address.

pub fn set_name<T: Into<String>>(&mut self, value: T)

Filter by name.

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

Filter by name.

pub fn set_project<T: Into<ProjectRef>>(&mut self, value: T)

Filter by project (also commonly known as tenant).

pub fn with_project<T: Into<ProjectRef>>(self, value: T) -> Self

Filter by project (also commonly known as tenant).

pub fn set_status<T: Into<ServerStatus>>(&mut self, value: T)

Filter by server status.

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

Filter by server status.

pub fn set_user<T: Into<UserRef>>(&mut self, value: T)

Filter by user.

pub fn with_user<T: Into<UserRef>>(self, value: T) -> Self

Filter by user.

pub fn detailed(self) -> DetailedServerQuery

Convert this query into a detailed query.

Detailed queries return full Server objects instead of just ServerSummary.

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

Convert this query into a stream executing the request.

This stream yields only ServerSummary objects, containing IDs and names. Use detailed().into_stream() for full Server objects.

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<ServerSummary>>

Execute this request and return all results.

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

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

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 ServerQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerQuery

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

Formats the value using the given formatter.

impl From<DetailedServerQuery> for ServerQuery

fn from(value: DetailedServerQuery) -> ServerQuery

Converts to this type from the input type.

impl From<ServerQuery> for DetailedServerQuery

fn from(value: ServerQuery) -> DetailedServerQuery

Converts to this type from the input type.

impl ResourceQuery for ServerQuery

const DEFAULT_LIMIT: usize = 100

Default limit to use with this query.

type Item = ServerSummary

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.