Struct Header 

pub struct Header { /* private fields */ }

File header, identifier and version information

Implementations

impl Header

pub fn new( id: VaultId, name: String, cipher: Cipher, kdf: KeyDerivation, flags: VaultFlags, ) -> Self

Create a new header.

pub fn id(&self) -> &VaultId

Vault identifier.

pub fn id_mut(&mut self) -> &mut VaultId

Mutable identifier for this vault.

pub fn flags(&self) -> &VaultFlags

Reference to the vault flags.

pub fn flags_mut(&mut self) -> &mut VaultFlags

Mutable reference to the vault flags.

pub fn name(&self) -> &str

Get the public name for this vault.

pub fn set_name(&mut self, name: String)

Set the public name for this vault.

pub fn set_salt(&mut self, salt: Option<String>)

Set the salt for key derivation.

pub fn meta(&self) -> Option<&AeadPack>

Get the encrypted meta data for the vault.

pub fn set_meta(&mut self, meta: Option<AeadPack>)

Set the encrypted meta data for the vault.

pub fn set_seed(&mut self, seed: Option<Seed>)

Set the seed entropy for key derivation.

pub fn set_shared_access(&mut self, shared_access: SharedAccess)

Set shared access permissions.

pub async fn read_content_offset<P: AsRef<Path>>(path: P) -> Result<u64, Error>

Read the content offset for a vault file verifying the identity bytes first.

pub async fn read_content_offset_slice(buffer: &[u8]) -> Result<u64, Error>

Read the content offset for a vault slice verifying the identity bytes first.

pub async fn read_content_offset_stream<R: AsyncReadExt + AsyncSeek + Unpin + Send>( stream: R, ) -> Result<u64, Error>

Read the content offset for a stream verifying the identity bytes first.

pub async fn read_summary_file<P: AsRef<Path>>( file: P, ) -> Result<Summary, Error>

Read the summary for a vault from a file.

pub async fn read_summary_slice(buffer: &[u8]) -> Result<Summary, Error>

Read the summary for a slice of bytes.

pub async fn read_header_file<P: AsRef<Path>>(file: P) -> Result<Header, Error>

Read the header for a vault from a file.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Decodable for Header

fn decode<'life0, 'life1, 'async_trait, R>( &'life0 mut self, reader: &'life1 mut BinaryReader<R>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where R: 'async_trait + AsyncRead + AsyncSeek + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Decode from the binary reader into self.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Header

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

Formats the value using the given formatter.

impl Encodable for Header

fn encode<'life0, 'life1, 'async_trait, W>( &'life0 self, writer: &'life1 mut BinaryWriter<W>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where W: 'async_trait + AsyncWrite + AsyncSeek + Unpin + Send, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Encode self into the binary writer.

impl From<Header> for Vault

fn from(header: Header) -> Self

Converts to this type from the input type.

impl From<Summary> for Header

fn from(value: Summary) -> Self

Converts to this type from the input type.

impl From<Vault> for Header

fn from(value: Vault) -> Self

Converts to this type from the input type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 Serialize for Header

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Header

impl StructuralPartialEq for Header