SignRequest

viadkim::signer

Struct SignRequest

pub struct SignRequest<T> {Show 13 fields
    pub signing_key: T,
    pub algorithm: SigningAlgorithm,
    pub canonicalization: Canonicalization,
    pub domain: DomainName,
    pub header_selection: HeaderSelection,
    pub identity: Option<Identity>,
    pub body_length: BodyLength,
    pub selector: Selector,
    pub timestamp: Timestamp,
    pub expiration: Expiration,
    pub copy_headers: bool,
    pub ext_tags: Vec<(String, String)>,
    pub format: OutputFormat,
}

Expand description

A request for creation of a DKIM signature.

Fields§

§signing_key: T

The key to use for producing the cryptographic signature.

§algorithm: SigningAlgorithm

The signing algorithm to use in the a= tag. Must be compatible with the signing key.

§canonicalization: Canonicalization

The canonicalization to use in the c= tag.

§domain: DomainName

The signing domain to use in the d= tag.

§header_selection: HeaderSelection

The selection of headers to include in the h= tag.

§identity: Option<Identity>

The agent or user identifier to use in the i= tag.

§body_length: BodyLength

The length of the message body in the l= tag.

§selector: Selector

The selector to use in the s= tag.

§timestamp: Timestamp

The timestamp value to record in the t= tag.

§expiration: Expiration

The expiration timestamp to specify in the x= tag.

§copy_headers: bool

Whether to record all headers used to create the signature in the z= tag.

§ext_tags: Vec<(String, String)>

Additional tag/value pairs to include in the signature.

§format: OutputFormat

The formatting options to use for producing the formatted DKIM-Signature header.

Implementations§

impl<T> SignRequest<T>

pub fn new( domain: DomainName, selector: Selector, algorithm: SigningAlgorithm, signing_key: T, ) -> Self

Creates a request for signing using practical default values.

The default settings used are not necessarily the Default values of each type, but values that are sensible in practice: c= is relaxed/simple, x= is five days.

Trait Implementations§

impl<T: Debug> Debug for SignRequest<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for SignRequest<T>
where T: Freeze,

impl<T> !RefUnwindSafe for SignRequest<T>

impl<T> Send for SignRequest<T>
where T: Send,

impl<T> Sync for SignRequest<T>
where T: Sync,

impl<T> Unpin for SignRequest<T>
where T: Unpin,

impl<T> !UnwindSafe for SignRequest<T>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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