Struct Request 

pub struct Request<UT, RT>
where
    UT: UpdateTokenTrait,
    RT: RequestTrait,
{
    pub client: Client,
    pub endpoint: String,
    pub token: Option<Token>,
    pub ut: Option<UT>,
    pub rt: Option<RT>,
    /* private fields */
}

The client request simplifies creating, sending, and handling an ncryptf request and response by providing a simplified API that utilizes reqwest underneath.

Requests can be constructed by calling:

let mut request = ncryptf::client::Request::<T>::new(client, "https://www.ncryptf.com", Some(ncryptf::Token), Some(T));

Where T is an implementation of UpdateTokenTrait, which provides an essential function for handling refresh tokens. When the Token object is updated, UpdateTokenTrait::token_update will be called with the new token for you to handle. If you wish to handle this separatedly, you can use the UpdateTokenImpl dummy trait.

and then use the helper http verb methods to make an request, which will automatically handle setting up an encrypted request for you which includes bootstraping a new encryption key from a compliant server, and encrypting the request with a one-time encryption key that is thrown away at the end of the request

let response: ncryptf::Client::Response = request.get("/user/1").await.unwrap();
let response: ncryptf::Client::Response = request.delete("/user/1").await.unwrap();
let response: ncryptf::Client::Response = request.post("/user", "{ ... json ...}").await.unwrap();
let response: ncryptf::Client::Response = request.put("/user/1", "{ .. json ..}").await.unwrap();

NOTE: Only GET, DELETE, POST, PATHCH, and PUT verbs are supported for this client library – you likely do not need to have an encrypted HEAD, or OPTIONS for an API.

An ncryptf::Client::Response is emitted on success. The response automatically handles decrypting the response for your application.

Fields

client: Client

endpoint: String

token: Option<Token>

ut: Option<UT>

rt: Option<RT>

Implementations

impl<UT: UpdateTokenTrait, RT: RequestTrait> Request<UT, RT>

pub fn new_simple(client: Client, endpoint: &str, token: Option<Token>) -> Self

Constructs a new request

pub fn new( client: Client, endpoint: &str, token: Option<Token>, ut: Option<UT>, rt: Option<RT>, ) -> Self

Constructs a new request

pub fn update_token(&mut self, token: Option<Token>)

Updates the token in both the current instance and via the callback

pub fn rekey<'life_self, 'async_recursion>( &'life_self mut self, hashid: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<bool, RequestError>> + Send + 'async_recursion>>

where 'life_self: 'async_recursion,

This will bootstrap our request and get the necessary encryption keys to encrypt the request and decrypt the response This function is recursive, and will call itself until it ensures the underlying data is encrypted and non-readable

pub async fn get(&mut self, url: &str) -> Result<Response, RequestError>

Performs an HTTP GET request

pub async fn delete( &mut self, url: &str, payload: Option<&str>, ) -> Result<Response, RequestError>

Performs an HTTP DELETE request

pub async fn patch( &mut self, url: &str, payload: Option<&str>, ) -> Result<Response, RequestError>

Performs an HTTP PATCH request

pub async fn post( &mut self, url: &str, payload: Option<&str>, ) -> Result<Response, RequestError>

Performs an HTTP POST request

pub async fn put( &mut self, url: &str, payload: Option<&str>, ) -> Result<Response, RequestError>

Performs an HTTP PUT request

Trait Implementations

impl<UT, RT> Clone for Request<UT, RT>

where UT: UpdateTokenTrait + Clone, RT: RequestTrait + Clone,

fn clone(&self) -> Request<UT, RT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT, RT> Debug for Request<UT, RT>

where UT: UpdateTokenTrait + Debug, RT: RequestTrait + Debug,

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

Formats the value using the given formatter.