Struct osauth::sync::SyncSession

pub struct SyncSession { /* fields omitted */ }

A synchronous wrapper for an asynchronous session.

Implementations

impl SyncSession

pub fn new(session: Session) -> SyncSession

Create a new synchronous wrapper.

Panics if unable to create a single-threaded runtime.

pub fn from_config<S: AsRef<str>>(cloud_name: S) -> Result<SyncSession>

Create a SyncSession from a clouds.yaml configuration file.

See Session::from_config for details.

pub fn from_env() -> Result<SyncSession>

Create a SyncSession from environment variables.

See Session::from_env for details.

pub fn auth_type(&self) -> &dyn AuthType

Get a reference to the authentication type in use.

pub fn endpoint_filters(&self) -> &EndpointFilters

Endpoint interface in use (if any).

pub fn endpoint_filters_mut(&mut self) -> &mut EndpointFilters

Modify endpoint filters.

This call clears the cached service information for this Session. It does not, however, affect clones of this Session.

pub fn refresh(&mut self) -> Result<()>

Refresh the session.

pub fn session(&self) -> &Session

Reference to the asynchronous session used.

pub fn set_auth_type<Auth: AuthType + 'static>(&mut self, auth_type: Auth)

Set a new authentication for this Session.

This call clears the cached service information for this Session. It does not, however, affect clones of this Session.

pub fn set_endpoint_interface(&mut self, endpoint_interface: InterfaceType)

A convenience call to set an endpoint interface.

This call clears the cached service information for this Session. It does not, however, affect clones of this Session.

pub fn with_auth_type<Auth: AuthType + 'static>(
    mut self: Self,
    auth_method: Auth
) -> SyncSession

Convert this session into one using the given authentication.

pub fn with_endpoint_filters(
    mut self: Self,
    endpoint_filters: EndpointFilters
) -> SyncSession

Convert this session into one using the given endpoint filters.

pub fn with_endpoint_interface(
    mut self: Self,
    endpoint_interface: InterfaceType
) -> SyncSession

Convert this session into one using the given endpoint filters.

pub fn get_api_versions<Srv>(
    &self,
    service: Srv
) -> Result<Option<(ApiVersion, ApiVersion)>> where
    Srv: ServiceType + Send, 

Get minimum/maximum API (micro)version information.

Returns None if the range cannot be determined, which usually means that microversioning is not supported.

let session = osauth::sync::SyncSession::from_env()
    .expect("Failed to create an identity provider from the environment");
let maybe_versions = session
    .get_api_versions(osauth::services::COMPUTE)
    .expect("Cannot determine supported API versions");
if let Some((min, max)) = maybe_versions {
    println!("The compute service supports versions {} to {}", min, max);
} else {
    println!("The compute service does not support microversioning");
}

pub fn get_endpoint<Srv, I>(&self, service: Srv, path: I) -> Result<Url> where
    Srv: ServiceType + Send,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send, 

Construct and endpoint for the given service from the path.

You won't need to use this call most of the time, since all request calls can fetch the endpoint automatically.

pub fn get_major_version<Srv>(&self, service: Srv) -> Result<Option<ApiVersion>> where
    Srv: ServiceType + Send, 

Get the currently used major version from the given service.

Can return None if the service does not support API version discovery at all.

pub fn pick_api_version<Srv, I>(
    &self,
    service: Srv,
    versions: I
) -> Result<Option<ApiVersion>> where
    Srv: ServiceType + Send,
    I: IntoIterator<Item = ApiVersion>,
    I::IntoIter: Send, 

Pick the highest API version supported by the service.

Returns None if none of the requested versions are available.

let session = osauth::sync::SyncSession::from_env()
    .expect("Failed to create an identity provider from the environment");
let candidates = vec![osauth::ApiVersion(1, 2), osauth::ApiVersion(1, 42)];
let maybe_version = session
    .pick_api_version(osauth::services::COMPUTE, candidates)
    .expect("Cannot negotiate an API version");
if let Some(version) = maybe_version {
    println!("Using version {}", version);
} else {
    println!("Using the base version");
}

pub fn supports_api_version<Srv: ServiceType + Send>(
    &self,
    service: Srv,
    version: ApiVersion
) -> Result<bool>

Check if the service supports the API version.

pub fn request<Srv, I>(
    &self,
    service: Srv,
    method: Method,
    path: I,
    api_version: Option<ApiVersion>
) -> Result<RequestBuilder> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send, 

Make an HTTP request to the given service.

The service argument is an object implementing the ServiceType trait. Some known service types are available in the services module.

The path argument is a URL path without the service endpoint (e.g. /servers/1234).

If api_version is set, it is send with the request to enable a higher API version. Otherwise the base API version is used. You can use pick_api_version to choose an API version to use.

The result is a RequestBuilder that can be customized further. Error checking and response parsing can be done using e.g. send_checked or fetch_json.

use reqwest::Method;

let session = osauth::sync::SyncSession::from_env()
    .expect("Failed to create an identity provider from the environment");
session
    .request(osauth::services::COMPUTE, Method::HEAD, &["servers", "1234"], None)
    .and_then(|builder| session.send_checked(builder))
    .map(|response| {
        println!("Response: {:?}", response);
    });

This is the most generic call to make a request. You may prefer to use more specific get, post, put or delete calls instead.

pub fn get<Srv, I>(
    &self,
    service: Srv,
    path: I,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send, 

Issue a GET request.

See request for an explanation of the parameters.

pub fn get_json<Srv, I, T>(
    &self,
    service: Srv,
    path: I,
    api_version: Option<ApiVersion>
) -> Result<T> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    T: DeserializeOwned + Send, 

Fetch a JSON using the GET request.

use osproto::common::IdAndName;
use serde::Deserialize;

#[derive(Debug, Deserialize)]
pub struct ServersRoot {
    pub servers: Vec<IdAndName>,
}

let session = osauth::sync::SyncSession::from_env()
    .expect("Failed to create an identity provider from the environment");

session
    .get_json(osauth::services::COMPUTE, &["servers"], None)
    .map(|servers: ServersRoot| {
        for srv in servers.servers {
            println!("ID = {}, Name = {}", srv.id, srv.name);
        }
    });

See request for an explanation of the parameters.

pub fn get_json_query<Srv, I, Q, T>(
    &self,
    service: Srv,
    path: I,
    query: Q,
    api_version: Option<ApiVersion>
) -> Result<T> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    Q: Serialize + Send,
    T: DeserializeOwned + Send, 

Fetch a JSON using the GET request with a query.

See reqwest crate documentation for how to define a query. See request for an explanation of the parameters.

pub fn get_query<Srv, I, Q>(
    &self,
    service: Srv,
    path: I,
    query: Q,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    Q: Serialize + Send, 

Issue a GET request with a query

See reqwest crate documentation for how to define a query. See request for an explanation of the parameters.

pub fn download(
    &self,
    response: Response
) -> SyncStream<'_, impl Stream<Item = SyncStreamItem>>

Download a body from a response.

use std::io::Read;

let session = osauth::sync::SyncSession::from_env()
    .expect("Failed to create an identity provider from the environment");

session
    .get(osauth::services::OBJECT_STORAGE, &["test-container", "test-object"], None)
    .map(|response| {
        let mut buffer = Vec::new();
        session
            .download(response)
            .read_to_end(&mut buffer)
            .map(|_| {
                println!("Data: {:?}", buffer);
            })
            // Do not do this in production!
            .expect("Could not read the remote file")
    })
    .expect("Could not open the remote file");

pub fn post<Srv, I, T>(
    &self,
    service: Srv,
    path: I,
    body: T,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    T: Serialize + Send, 

POST a JSON object.

The body argument is anything that can be serialized into JSON.

See request for an explanation of the other parameters.

pub fn post_json<Srv, I, T, R>(
    &self,
    service: Srv,
    path: I,
    body: T,
    api_version: Option<ApiVersion>
) -> Result<R> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    T: Serialize + Send,
    R: DeserializeOwned + Send, 

POST a JSON object and receive a JSON back.

The body argument is anything that can be serialized into JSON.

See request for an explanation of the other parameters.

pub fn put<Srv, I, T>(
    &self,
    service: Srv,
    path: I,
    body: T,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    T: Serialize + Send, 

PUT a JSON object.

The body argument is anything that can be serialized into JSON.

See request for an explanation of the other parameters.

pub fn put_empty<Srv, I>(
    &self,
    service: Srv,
    path: I,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send, 

Issue an empty PUT request.

See request for an explanation of the parameters.

pub fn put_json<Srv, I, T, R>(
    &self,
    service: Srv,
    path: I,
    body: T,
    api_version: Option<ApiVersion>
) -> Result<R> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send,
    T: Serialize + Send,
    R: DeserializeOwned + Send, 

PUT a JSON object and receive a JSON back.

The body argument is anything that can be serialized into JSON.

See request for an explanation of the other parameters.

pub fn delete<Srv, I>(
    &self,
    service: Srv,
    path: I,
    api_version: Option<ApiVersion>
) -> Result<Response> where
    Srv: ServiceType + Send + Clone,
    I: IntoIterator,
    I::Item: AsRef<str>,
    I::IntoIter: Send, 

Issue a DELETE request.

See request for an explanation of the parameters.

pub fn fetch_json<T>(&self, builder: RequestBuilder) -> Result<T> where
    T: DeserializeOwned + Send, 

Send the response and convert the response to a JSON.

pub fn send_checked(&self, builder: RequestBuilder) -> Result<Response>

Check the response and convert errors into OpenStack ones.

Trait Implementations

impl Clone for SyncSession

pub fn clone(&self) -> SyncSession

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyncSession

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

Formats the value using the given formatter.

impl From<Session> for SyncSession

pub fn from(value: Session) -> SyncSession

Performs the conversion.

impl From<SyncSession> for Session

pub fn from(value: SyncSession) -> Session

Performs the conversion.