Struct unkey::Client

pub struct Client { /* private fields */ }

The client used to make requests to the unkey api.

Implementations

impl Client

pub fn new(key: &str) -> Self

Creates a new client.

Arguments

• key: The root api key the client should send with requests.

Returns

The new client.

Example

let c = Client::new("unkey_ghj");

pub fn with_url(key: &str, url: &str) -> Self

Creates a new client with a different base url than the production unkey api url.

Arguments

• key: The root api key the client should send with requests.
• url: The base url to use, excluding trailing slash. i.e. http://localhost:3000.

Returns

The new client.

Example

let c = Client::with_url("unkey_ghj", "http://localhost:3000");

pub fn set_key(&mut self, key: &str)

Updates the root api key for the client.

Arguments

• key: The new root api key the client should send with requests.

Example

let mut c = Client::new("unkey_ghj");
c.set_key("unkey_abc");

pub fn set_url(&mut self, url: &str)

Sets the url the client will send requests to.

Arguments

• url: The new base url to use.

Example

let mut c = Client::new("unkey_ghj");
c.set_url("http://localhost:6969");

pub async fn verify_key( &self, req: VerifyKeyRequest, ) -> Result<VerifyKeyResponse, HttpError>

Verifies an existing api key.

Arguments

• req: The verify key request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = VerifyKeyRequest::new("test_KEYABC", "api_123123");

match c.verify_key(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn create_key( &self, req: CreateKeyRequest, ) -> Result<CreateKeyResponse, HttpError>

Creates a new api key.

Arguments

• req: The create key request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = CreateKeyRequest::new("api_CCC").set_remaining(100);

match c.create_key(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn list_keys( &self, req: ListKeysRequest, ) -> Result<ListKeysResponse, HttpError>

Retrieves a paginated list of api keys.

Arguments

• req: The list keys request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = ListKeysRequest::new("api_id").set_limit(25);

match c.list_keys(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn revoke_key(&self, req: RevokeKeyRequest) -> Result<(), HttpError>

Revokes an existing api key.

Arguments

• req: The revoke key request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = RevokeKeyRequest::new("test_123");

match c.revoke_key(req).await {
    Ok(_) => println!("Success!"), // Nothing on success
    Err(err) => println!("{:?}", err),
}

pub async fn get_api( &self, req: GetApiRequest, ) -> Result<GetApiResponse, HttpError>

Retrieves information for the given api id.

Arguments

• req: The get api request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = GetApiRequest::new("api_id");

match c.get_api(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn update_key(&self, req: UpdateKeyRequest) -> Result<(), HttpError>

Retrieves information for the given api id.

Arguments

• req: The get api request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = UpdateKeyRequest::new("api_id").set_remaining(Some(100));

match c.update_key(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn get_key(&self, req: GetKeyRequest) -> Result<ApiKey, HttpError>

Retrieves information for the given api id.

Arguments

• req: The get key request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = GetKeyRequest::new("key_id");

match c.get_key(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

pub async fn update_remaining( &self, req: UpdateRemainingRequest, ) -> Result<UpdateRemainingResponse, HttpError>

Update the remaining verifications for a key.

Arguments

• req: The update remaining request to send.

Returns

A Result containing the response, or an error.

Errors

The HttpError, if one occurred.

Example

let c = Client::new("abc123");
let req = UpdateRemainingRequest::new("key_id", Some(100), UpdateOp::Set);

match c.update_remaining(req).await {
    Ok(res) => println!("{:?}", res),
    Err(err) => println!("{:?}", err),
}

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.