Enum ExportFormat 

pub enum ExportFormat {
    Vault,
    EncryptedVault,
    Text,
    Json,
    EncryptedJson,
    Html,
}

An export format this library writes.

The six are the interface’s numbered choices, in the order the interface offers them: the two .q2fa containers first, then the four shapes another authenticator reads. Which one a caller offers is a user interface question; the differences that matter to the library are ExportFormat::needs_password and ExportFormat::group_carrying.

Variants

Vault

A plain .q2fa: the master key in clear plus the whole vault ciphertext.

This is the format that restores an account on a clean device. Whoever holds the file holds the master key, which is why the interface warns about it more strongly than about the encrypted form.

EncryptedVault

A passphrase-protected .q2fa: the master key wrapped by crate::recovery plus the whole vault ciphertext.

Text

The text export: one otpauth:// URI per line.

Json

The JSON export, readable as it stands.

EncryptedJson

The JSON export, encrypted with a password the caller supplies.

Html

The HTML export: a table with one row per entry and the code drawn beside it.

Implementations

impl ExportFormat

pub const ALL: [Self; 6]

Every format, in the order the interface offers them.

pub const fn name(self) -> &'static str

The name used in messages and diagnostics.

pub const fn extension(self) -> &'static str

The file name extension this format is normally written with.

Both JSON forms share one: they are the same file with and without a password, and a reader tells them apart by the db field being a string rather than an object. Both .q2fa forms share one for the same reason: they are told apart by their magic.

pub const fn needs_password(self) -> bool

Whether this format is written with a password.

A caller uses it to decide whether to ask for one before calling export, rather than calling and handling Error::ExportPasswordRequired.

pub const fn group_carrying(self) -> GroupCarrying

How much of the group tree this format carries.

pub const fn carries_groups(self) -> bool

Whether this format carries the groups at all.

Trait Implementations

impl Clone for ExportFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExportFormat

impl Debug for ExportFormat

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

Formats the value using the given formatter.

impl Eq for ExportFormat

impl PartialEq for ExportFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExportFormat