Skip to main content

DkimSigningStream

Struct DkimSigningStream 

Source
pub struct DkimSigningStream<'a, T: SigningKey> { /* private fields */ }
Expand description

A streaming DKIM signer that allows signing messages in chunks.

This is useful when you want to avoid loading the entire message into memory before signing. Headers are buffered internally until the header/body boundary is detected, then body content is streamed through the hasher.

§Example

let signer = DkimSigner::from_key(key)
    .domain("example.com")
    .selector("default")
    .headers(["From", "To", "Subject"]);

let mut stream = signer.sign_streaming();
stream.write(b"From: sender@example.com\r\n");
stream.write(b"To: recipient@example.com\r\n");
stream.write(b"Subject: Test\r\n");
stream.write(b"\r\n");
stream.write(b"Body content here...");

let signature = stream.finish()?;

Implementations§

Source§

impl<T: SigningKey> DkimSigningStream<'_, T>

Source

pub fn write(&mut self, chunk: &[u8])

Feed a chunk of raw message data to the signer.

Data should be provided in order, starting with headers. The header/body boundary (\r\n\r\n) is automatically detected.

While reading headers, all data is buffered. Once the header/body boundary is detected, subsequent body data is streamed directly to the hasher.

Source

pub fn finish(self) -> Result<Signature>

Finalize the signature.

Consumes the stream and returns the DKIM signature. The current system time is used for the t= timestamp.

§Errors

Returns an error if:

  • No headers matching the signer’s header list were found
  • The cryptographic signing operation fails
  • finish() was already called

Auto Trait Implementations§

§

impl<'a, T> Freeze for DkimSigningStream<'a, T>
where <<T as SigningKey>::Hasher as HashImpl>::Context: Freeze,

§

impl<'a, T> RefUnwindSafe for DkimSigningStream<'a, T>

§

impl<'a, T> Send for DkimSigningStream<'a, T>
where T: Sync, <<T as SigningKey>::Hasher as HashImpl>::Context: Send,

§

impl<'a, T> Sync for DkimSigningStream<'a, T>
where T: Sync, <<T as SigningKey>::Hasher as HashImpl>::Context: Sync,

§

impl<'a, T> Unpin for DkimSigningStream<'a, T>
where <<T as SigningKey>::Hasher as HashImpl>::Context: Unpin,

§

impl<'a, T> UnsafeUnpin for DkimSigningStream<'a, T>

§

impl<'a, T> UnwindSafe for DkimSigningStream<'a, T>

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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