Struct self_encryption::SelfEncryptor

pub struct SelfEncryptor<S>(_);

This is the encryption object and all file handling should be done using this object as the low level mechanism to read and write content. This library has no knowledge of file metadata.

Methods

impl<S> SelfEncryptor<S> where
    S: Storage + 'static, 

pub fn new(
    storage: S,
    data_map: DataMap
) -> Result<SelfEncryptor<S>, SelfEncryptionError<S::Error>>

This is the only constructor for an encryptor object. Each SelfEncryptor is used for a single file. The parameters are a Storage object and a DataMap. For a file which has not previously been self-encrypted, use DataMap::None.

pub fn write(
    &self,
    data: &[u8],
    position: u64
) -> Box<dyn Future<Item = (), Error = SelfEncryptionError<S::Error>>>

Write method mirrors a POSIX type write mechanism. It loosely mimics a filesystem interface for easy connection to FUSE-like programs as well as fine grained access to system level libraries for developers. The input data will be written from the specified position (starts from 0).

pub fn read(
    &self,
    position: u64,
    length: u64
) -> Box<dyn Future<Item = Vec<u8>, Error = SelfEncryptionError<S::Error>>>

The returned content is read from the specified position with specified length. Trying to read beyond the file size will cause the encryptor to return content filled with 0u8s in the gap (file size isn't affected). Any other unwritten gaps will also be filled with '0u8's.

pub fn close(
    self
) -> Box<dyn Future<Item = (DataMap, S), Error = SelfEncryptionError<S::Error>>>

This function returns a DataMap, which is the info required to recover encrypted content from data storage location. Content temporarily held in the encryptor will only get flushed into storage when this function gets called.

pub fn truncate(
    &self,
    new_size: u64
) -> Box<dyn Future<Item = (), Error = SelfEncryptionError<S::Error>>>

Truncate the self_encryptor to the specified size (if extended, filled with 0u8s).

pub fn len(&self) -> u64

Current file size as is known by encryptor.

pub fn is_empty(&self) -> bool

Returns true if file size as is known by encryptor == 0.

pub fn into_storage(self) -> S

Consume this encryptor and return its storage.

Trait Implementations

impl<S: Storage> Debug for SelfEncryptor<S>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.