Struct EncryptedBlockStorage 

pub struct EncryptedBlockStorage<S> { /* private fields */ }

Implementations

impl<S> EncryptedBlockStorage<S>

where S: AnyBlockStorage,

pub fn new( next: S, key: Secret, algorithm: Algorithm, mapping: EncryptedBlockStorageMapping, ) -> Self

pub fn with_encryption_reference_mode( self, mode: EncryptionReferenceMode, ) -> Self

pub fn storage(&self) -> &S

Get next storage.

pub fn set_storage(&mut self, next: S)

Set next storage.

pub async fn insert_mappings( &self, mappings: impl IntoIterator<Item = MappedCid>, )

Add known mappings.

pub async fn load_mapping(&self, map: &Cid) -> Result<(), StorageError>

Load mapping from CID. This will add the mappings to the existing.

pub async fn flush_mapping(&self) -> Result<Option<Cid>, StorageError>

Flush mapping to (parent) storage. Returns the encrypted mapping CID. The mapping tree will also only link to encrypted CIDs.

pub async fn clear_mapping(&self, keep: impl IntoIterator<Item = Cid>)

Clear encryption mapping.

pub async fn regenerate_mapping( &mut self, cids: impl Iterator<Item = Cid>, ) -> Result<Option<Cid>, StorageError>

This will regenerate and flush the encryption block mapping using supplied CIDs.

pub async fn insert_mapping( &self, encrypted: &Cid, plain: Option<&Cid>, ) -> Result<bool, StorageError>

👎Deprecated

Insert mapping for encrypted block. Returns true if mapping has been changed.

pub async fn get_unencrypted(&self, cid: &Cid) -> Result<Block, StorageError>

Get encrypted cid as unencrypted block.

pub async fn set_encrypted(&self, block: Block) -> Result<Cid, StorageError>

Set encrypted block. Expects the encrypted block belongs to our key.

Errors:

• StorageError::InvalidArgument: Block can not be decrypted.

Trait Implementations

impl<S> BlockStorage for EncryptedBlockStorage<S>

where S: AnyBlockStorage,

fn get<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<Block, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get block.

fn set<'life0, 'async_trait>( &'life0 self, block: Block, ) -> Pin<Box<dyn Future<Output = Result<Cid, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Inserts a block into storage.

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a block.

fn stat<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<BlockStat, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stat a block.

fn max_block_size(&self) -> usize

Maximum accepted block size.

impl<S> BlockStorageContentMapping for EncryptedBlockStorage<S>

where S: BlockStorage + Clone + Send + Sync + 'static,

fn is_content_mapped<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Whether the mapping is active.

fn to_plain<'life0, 'life1, 'async_trait>( &'life0 self, mapped: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Option<Cid>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convert the mapped Cid to an plain storage Cid.

fn to_mapped<'life0, 'life1, 'async_trait>( &'life0 self, plain: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Option<Cid>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convert the plain storage Cid to a mapped Cid.

fn insert_mappings<'life0, 'async_trait>( &'life0 self, mappings: BTreeSet<MappedCid>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Insert mappings explicitly into storage.

impl<S: Clone> Clone for EncryptedBlockStorage<S>

fn clone(&self) -> EncryptedBlockStorage<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> CloneWithBlockStorageSettings for EncryptedBlockStorage<S>

where S: CloneWithBlockStorageSettings,

fn clone_with_settings(&self, settings: BlockStorageCloneSettings) -> Self

fn without_networking(&self) -> Self

impl<S: Debug> Debug for EncryptedBlockStorage<S>

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

Formats the value using the given formatter.

impl<S> ExtendedBlockStorage for EncryptedBlockStorage<S>

where S: ExtendedBlockStorage + Clone + 'static,

fn set_extended<'life0, 'async_trait>( &'life0 self, extended_block: ExtendedBlock, ) -> Pin<Box<dyn Future<Output = Result<Cid, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Inserts a block into storage.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, cid: &'life1 Cid, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Test if a Cid exists.

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear the storage by removing all entries.