Struct MessageBuilder 

pub struct MessageBuilder<'a> { /* private fields */ }

A struct used to construct a message.

It implements a Rust twist on the state pattern by returning intermediate types: SignedMessage, SymEncryptedMessage and AsmEncryptedMessage. They all implement the MessageFinal trait with the return types being:

• Result<Message> for SymEncryptedMessage and AsmEncryptedMessage,
• Message for SignedMessage.

In addition the SignedMessage type implements the following methods:

• encrypt_for,
• encrypt_with, which have the same API and functionality as their counterparts defined in MessageBuilder.

Example

A typical message build method call chain:

let msg = Message::new(&larry)? // start building a message (issuer: larry)
    .write(&plaintext[..])? // add plaintext content to the message
    .sign() // sign the message (issuer: larry)
    .encrypt_for(&friends)? // asymmetrically encrypt the message (for friends)
    .finalize()?; // finalize the message (returns Result<Message>)

Implementations

impl<'a> MessageBuilder<'a>

pub fn write<R: Read>(self, content: R) -> Result<Self>

Adds plaintext content to the message. content must implement the Read trait.

Errors

• CryptoError::Unknown when a reading error or other error related to the reader object occured.

pub fn sign(self) -> SignedMessage<'a>

Signs the message.

pub fn encrypt_with( self, passphrase: impl AsRef<[u8]>, ) -> Result<SymEncryptedMessage<'a>>

Symmetrically encrypt the message using a passphrase.

pub fn encrypt_for( self, recipients: &'a [Arc<Cert>], ) -> Result<AsmEncryptedMessage<'a>>

Asymmetrically encrypts the message for every recipient in recipients.