Struct sequoia_autocrypt::AutocryptSetupMessage

pub struct AutocryptSetupMessage { /* private fields */ }

Holds an Autocrypt Setup Message.

An Autocrypt Setup Message is used to transfer a private key from one device to another.

Implementations

impl AutocryptSetupMessage

pub fn new(cert: Cert) -> Self

Creates a new Autocrypt Setup Message for the specified Cert.

You can set the prefer_encrypt setting, which defaults to “nopreference”, using set_prefer_encrypt.

Note: this generates a random passcode. To retrieve the passcode, use the passcode method.

To decode an Autocrypt Setup Message, use the from_bytes or from_reader methods.

pub fn set_prefer_encrypt(self, value: &str) -> Self

Sets the prefer encrypt header.

pub fn prefer_encrypt(&self) -> Option<&str>

Returns the prefer encrypt header.

pub fn set_passcode_format(self, value: &str) -> Self

Sets the “Passcode-Format” header.

pub fn passcode_format(&self) -> Option<&str>

Returns the “Passcode-Format” header.

pub fn set_passcode(self, passcode: Password) -> Self

Sets the passcode.

pub fn passcode(&self) -> Option<&Password>

Returns the ASM’s passcode.

If the passcode has not yet been generated, this returns None.

pub fn set_passcode_begin(self, value: &str) -> Self

Sets the “Passcode-Begin” header.

pub fn passcode_begin(&self) -> Option<&str>

Returns the “Passcode-Begin” header.

pub fn serialize<W>(&mut self, w: &mut W) -> Result<()>where W: Write + Send + Sync,

Generates the Autocrypt Setup Message.

The message is written to w.

pub fn from_bytes(bytes: &[u8]) -> Result<AutocryptSetupMessageParser<'_>>

Parses the autocrypt setup message in r.

passcode is the passcode used to protect the message.

pub fn from_reader<'a, R: Read + Send + Sync + 'a>( r: R ) -> Result<AutocryptSetupMessageParser<'a>>

Parses the autocrypt setup message in r.

passcode is the passcode used to protect the message.

pub fn into_cert(self) -> Cert

Returns the Cert consuming the AutocryptSetupMessage in the process.

Trait Implementations

impl Debug for AutocryptSetupMessage

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

Formats the value using the given formatter.

impl PartialEq<AutocryptSetupMessage> for AutocryptSetupMessage

fn eq(&self, other: &AutocryptSetupMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AutocryptSetupMessage