Struct imagevault::Client

pub struct Client<T: Authentication + Sync> {
    pub client_identity: String,
    pub client_secret: String,
    pub authentication: Option<Arc<Mutex<T>>>,
    pub reqwest_client: ReqwestClient,
    pub base_url: Url,
}

Client

A client that is used to consume the ImageVault API.

Remarks

The client saves and mutates the authentication, so it is recommended to re-use the client as much as possible in order to minimize the need to re-authenticate.

Fields

client_identity: String

client_secret: String

authentication: Option<Arc<Mutex<T>>>

reqwest_client: ReqwestClient

base_url: Url

Implementations

impl<T: Authentication + Sync> Client<T>

pub fn new(
    client_identity: &str,
    client_secret: &str,
    base_url: &str
) -> Result<Self, ImageVaultError>

Creates a new Client

Arguments

• client_identity - The client identity
• client_secret - The client secret
• base_url - The base URL to ImageVault, e.g. https://myimagevault.se

pub fn with_authentication(self, authentication: T) -> Self

Adds authentication to the Client

Arguments

• authentication - The Authentication to use

Remarks

Pretty much everything in the ImageVault API requires authentication, so this should be included most of the time.

Examples

use imagevault::{
    Client,
    authentication::ClientCredentialsAuthentication,
};

let authentication = ClientCredentialsAuthentication::default();

let client = Client::new(
    "identity",
    "secret",
    "https://myimagevault.local"
    )?
    .with_authentication(authentication);