Struct AsyncOpenStack

pub struct AsyncOpenStack { /* private fields */ }

Asynchronous client for the OpenStack API for a single user

Separate Identity (not the scope) should use separate instances of this.

use openstack_sdk::api::{paged, Pagination, QueryAsync};
use openstack_sdk::{AsyncOpenStack, config::ConfigFile, OpenStackError};
use openstack_sdk::types::ServiceType;
use openstack_sdk::api::compute::v2::flavor::list;

async fn list_flavors() -> Result<(), OpenStackError> {
    // Get the builder for the listing Flavors Endpoint
    let mut ep_builder = list::Request::builder();
    // Set the `min_disk` query param
    ep_builder.min_disk("15");
    let ep = ep_builder.build().unwrap();

    let cfg = ConfigFile::new().unwrap();
    // Get connection config from clouds.yaml/secure.yaml
    let profile = cfg.get_cloud_config("devstack").unwrap().unwrap();
    // Establish connection
    let mut session = AsyncOpenStack::new(&profile).await?;

    // Invoke service discovery when desired.
    session.discover_service_endpoint(&ServiceType::Compute).await?;

    // Execute the call with pagination limiting maximum amount of entries to 1000
    let data: Vec<serde_json::Value> = paged(ep, Pagination::Limit(1000))
        .query_async(&session)
        .await.unwrap();

    println!("Data = {:?}", data);
    Ok(())
}

Implementations

impl AsyncOpenStack

pub async fn new(config: &CloudConfig) -> Result<Self, OpenStackError>

Create a new OpenStack API session from CloudConfig

pub async fn new_interactive( config: &CloudConfig, renew_auth: bool, ) -> Result<Self, OpenStackError>

Create a new OpenStack API session from CloudConfig

pub async fn authorize( &mut self, scope: Option<AuthTokenScope>, interactive: bool, renew_auth: bool, ) -> Result<(), OpenStackError>

Authorize against the cloud using provided credentials and get the session token

pub async fn discover_service_endpoint( &mut self, service_type: &ServiceType, ) -> Result<(), OpenStackError>

Perform version discovery of a service

pub fn get_token_catalog(&self) -> Option<Vec<ServiceEndpoints>>

Return catalog information given in the token

pub fn get_auth_info(&self) -> Option<AuthResponse>

Return current authentication information

pub fn get_auth_state(&self, offset: Option<TimeDelta>) -> Option<AuthState>

Return current authentication status

Offset can be used to calculate imminent expiration.

pub fn get_auth_token(&self) -> Option<String>

Return current authentication token

pub async fn fetch_token_info<S: AsRef<str>>( &self, token: S, ) -> Result<AuthResponse, OpenStackError>

Perform token introspection call

Trait Implementations

impl AsyncClient for AsyncOpenStack

fn rest_read_body_async<'life0, 'async_trait>( &'life0 self, request: Builder, body: BoxedAsyncRead, ) -> Pin<Box<dyn Future<Output = Result<HttpResponse<Bytes>, ApiError<<Self as RestClient>::Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform REST request with the body read from AsyncRead

fn download_async<'life0, 'async_trait>( &'life0 self, request: Builder, body: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<(HeaderMap, BoxedAsyncRead), ApiError<<Self as RestClient>::Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Download result of HTTP operation.

fn rest_async<'life0, 'async_trait>( &'life0 self, request: Builder, body: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<HttpResponse<Bytes>, ApiError<<Self as RestClient>::Error>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a REST query asynchronously.

impl Clone for AsyncOpenStack

fn clone(&self) -> AsyncOpenStack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncOpenStack

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

Formats the value using the given formatter.

impl RestClient for AsyncOpenStack

fn get_service_endpoint( &self, service_type: &ServiceType, version: Option<&ApiVersion>, ) -> Result<&ServiceEndpoint, ApiError<Self::Error>>

Get service endpoint from the catalog

fn get_current_project(&self) -> Option<Project>

Get project id from the current scope

type Error = RestError

The errors which may occur for this client.