Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

ACME HTTP Client

The client handles sending ACME HTTP requests, and providing ACME HTTP responses using the crate::Request and crate::Response objects respectively.

§Example

You can use a Client to send HTTP requests to an ACME provider, using either Client::get to send a plain HTTP GET request, or Client::execute to send a signed ACME HTTP request.

See crate::Request for more information on how to create a request.


let key = Arc::new(SignatureKind::Ecdsa(yacme_key::EcdsaAlgorithm::P256).random());

let mut client = Client::default();
client.set_new_nonce_url("https://acme.example.com/new-nonce".parse().unwrap());

let request = Request::get("https://acme.example.com/account/1".parse().unwrap(), key);
// This would normally be an actual response payload type, and not serde_json::Value.
let response: Response<serde_json::Value> = client.execute(request).await?;

Implementations§

Source§

impl Client

Source

pub fn builder() -> ClientBuilder

Create a new client builder to configure a client.

Source

pub fn set_new_nonce_url(&mut self, url: Url)

Set the URL used for fetching a new Nonce from the ACME provider.

Source§

impl Client

Source

pub async fn get<R>(&mut self, url: Url) -> Result<Response<R>, AcmeError>
where R: Decode,

Run a plain HTTP GET request without using the ACME HTTP JWS protocol.

Source

pub async fn execute<P, R>( &mut self, request: Request<P>, ) -> Result<Response<R>, AcmeError>
where P: Serialize, R: Decode,

Execute an HTTP request using the ACME protocol.

See crate::Request for more information on how to create a request.

Request payloads must be serializable, and request responses must implement Decode. Decode is implemented for all types that implement serde::Deserialize.

Trait Implementations§

Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Client

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,