Struct KeyFile

pub struct KeyFile {
    pub key: SecStr,
    pub file_type: KeyFileType,
}

A key file used for encrypting and decrypting the database.

Fields

key: SecStr

The key data.

file_type: KeyFileType

The type of key file.

Implementations

impl KeyFile

pub fn new() -> Result<KeyFile>

An convenience alias for KeyFile::new_xml().

pub fn new_binary() -> Result<KeyFile>

Attempts to create a new binary key file.

Examples

use kpdb::KeyFile;

let key = KeyFile::new_binary()?;

pub fn new_hex() -> Result<KeyFile>

Attempts to create a new hexadecimal key file.

Examples

use kpdb::KeyFile;

let key = KeyFile::new_hex()?;

pub fn new_xml() -> Result<KeyFile>

Attempts to create a new XML key file.

Examples

use kpdb::KeyFile;

let key = KeyFile::new_xml()?;

pub fn open<R: Read>(reader: &mut R) -> Result<KeyFile>

Attempts to open a key file.

Examples

use kpdb::KeyFile;
use std::fs::File;

let mut file = File::open("passwords.key")?;
let key = KeyFile::open(&mut file)?;

pub fn save<W: Write>(&self, writer: &mut W) -> Result<()>

Attempts to save the key file.

Examples

use kpdb::KeyFile;
use std::fs::File;

let key = KeyFile::new()?;
let mut file = File::create("new.key")?;

key.save(&mut file)?;

Trait Implementations

impl Clone for KeyFile

fn clone(&self) -> KeyFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyFile

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

Formats the value using the given formatter.

impl PartialEq for KeyFile

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for KeyFile