Struct openstack::network::PortQuery

pub struct PortQuery { /* fields omitted */ }

A query to port list.

Implementations

impl PortQuery

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

Add sorting to the request.

pub fn set_admin_state_up<T: Into<bool>>(&mut self, value: T)

Filter by administrative state.

pub fn with_admin_state_up<T: Into<bool>>(self, value: T) -> Self

Filter by administrative state.

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

Filter by description.

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

Filter by description.

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

Filter by the ID of the object attached to the port.

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

Filter by the ID of the object attached to the port.

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

Filter by the ID of the object attached to the port.

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

Filter by the ID of the object attached to the port.

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

Filter by MAC address.

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

Filter by MAC address.

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

Filter by port name.

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

Filter by port name.

pub fn set_network<N: Into<NetworkRef>>(&mut self, value: N)

Filter by network.

pub fn with_network<N: Into<NetworkRef>>(self, value: N) -> Self

Filter by network.

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

Filter by status.

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

Filter by status.

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

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

Execute this request and return all results.

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

pub fn one(self) -> Result<Port>

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 PortQuery

fn clone(&self) -> PortQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortQuery

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

Formats the value using the given formatter.

impl IntoFallibleIterator for PortQuery

type Item = Port

The elements of the iterator.

type Error = Error

The error value of the iterator.

type IntoFallibleIter = ResourceIterator<PortQuery>

The iterator.

fn into_fallible_iter(self) -> Self::IntoFallibleIter

Creates a fallible iterator from a value.

impl ResourceQuery for PortQuery

type Item = Port

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.