Struct File

pub struct File<FE, B> { /* private fields */ }

A transactional file

Implementations

impl<FE, B> File<FE, B>

pub fn into_inner(self) -> Inner<FE>

where FE: Send + Sync,

Destructure this File into its underlying freqfs::DirLock.

impl<FE, B> File<FE, B>

where FE: for<'a> FileSave<'a> + Clone,

pub async fn load(inner: Inner<FE>, txn_id: TxnId) -> TCResult<Self>

Load a File from its Inner cache representation.

impl<FE, B> File<FE, B>

where FE: for<'a> FileSave<'a> + AsType<B> + Clone, B: FileLoad + GetSize + Clone,

pub async fn block_ids( &self, txn_id: TxnId, ) -> TCResult<impl Iterator<Item = Key>>

Construct an iterator over the name of each block in this File at txn_id.

pub async fn create_block( &self, txn_id: TxnId, name: Id, contents: B, ) -> TCResult<BlockWrite<FE, B>>

Create a new block at txn_id with the given name and contents.

pub async fn delete_block(&self, txn_id: TxnId, name: Id) -> TCResult<bool>

Delete the block with the given name at txn_id and return true if it was present.

pub async fn contains_block(&self, txn_id: TxnId, name: &Id) -> TCResult<bool>

Return true if this File contains a block with the given name at txn_id.

pub async fn iter( &self, txn_id: TxnId, ) -> TCResult<impl Stream<Item = TCResult<(Key, BlockRead<FE, B>)>> + Send + Unpin + '_>

Iterate over the blocks in this File.

pub async fn read_block( &self, txn_id: TxnId, name: &Id, ) -> TCResult<BlockRead<FE, B>>

Lock the block at name for reading at txn_id.

pub async fn write_block( &self, txn_id: TxnId, name: &Id, ) -> TCResult<BlockWrite<FE, B>>

Lock the block at name for writing at txn_id.

Trait Implementations

impl<FE, B> Clone for File<FE, B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FE, B> Debug for File<FE, B>

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

Formats the value using the given formatter.

impl<FE, B> Transact for File<FE, B>

where FE: for<'a> FileSave<'a> + AsType<B> + Clone + Send + Sync, B: FileLoad + GetSize + Clone, Self: Send + Sync,

type Commit = ()

A guard which blocks concurrent commits

fn commit<'life0, 'async_trait>( &'life0 self, txn_id: TxnId, ) -> Pin<Box<dyn Future<Output = Self::Commit> + Send + 'async_trait>>

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

Commit this transaction.

fn rollback<'life0, 'life1, 'async_trait>( &'life0 self, txn_id: &'life1 TxnId, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Roll back this transaction.

fn finalize<'life0, 'life1, 'async_trait>( &'life0 self, txn_id: &'life1 TxnId, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Delete any version data specific to this transaction.