Struct picky::http::http_signature::HttpSignatureBuilder

pub struct HttpSignatureBuilder<'a> { /* fields omitted */ }

Utility to generate HttpSignatures

Methods

impl<'a> HttpSignatureBuilder<'a>

pub fn new() -> Self

pub fn key_id<S: Into<String>>(&self, key_id: S) -> &Self

Required

pub fn signature_method(
    &self,
    private_key: &'a PrivateKey,
    signature_type: SignatureHashType
) -> &Self

Required

pub fn created(&self, unix_timestamp: u64) -> &Self

If generating signing string, at least one of created, expires, request_target or http_header is required otherwise DO NOT provide.

pub fn expires(&self, unix_timestamp: u64) -> &Self

If generating signing string, at least one of created, expires, request_target or http_header is required otherwise DO NOT provide.

pub fn request_target(&self) -> &Self

If generating signing string, at least one of created, expires, request_target or http_header is required otherwise DO NOT provide.

pub fn http_header<S: Into<String>>(&self, header: S) -> &Self

If generating signing string, at least one of created, expires, request_target or http_header is required otherwise DO NOT provide.

pub fn generate_signing_string_using_http_request(
    &self,
    http_request: &'a dyn HttpRequest
) -> &Self

Required (alternative: pre_generated_signing_string).

pub fn pre_generated_signing_string(&self, signing_string: &'a str) -> &Self

Required (alternative: generate_signing_string_using_http_request).

pub fn build(&self) -> Result<HttpSignature, HttpSignatureError>

Trait Implementations

impl<'a> Clone for HttpSignatureBuilder<'a>

fn clone(&self) -> HttpSignatureBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HttpSignatureBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for HttpSignatureBuilder<'a>

fn default() -> HttpSignatureBuilder<'a>

Returns the "default value" for a type.