Struct tc_transact::fs::File

source ·
pub struct File<FE, B> { /* private fields */ }
Expand description

A transactional file

Implementations§

source§

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

source

pub fn into_inner(self) -> Inner<FE>
where FE: Send + Sync,

Destructure this File into its underlying freqfs::DirLock.

source§

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

source

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.

source

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.

source

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.

source

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.

source

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.

source

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§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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
source§

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.
source§

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.
source§

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.

Auto Trait Implementations§

§

impl<FE, B> !RefUnwindSafe for File<FE, B>

§

impl<FE, B> Send for File<FE, B>
where B: Send, FE: Sync + Send,

§

impl<FE, B> Sync for File<FE, B>
where B: Sync, FE: Sync + Send,

§

impl<FE, B> Unpin for File<FE, B>
where B: Unpin,

§

impl<FE, B> !UnwindSafe for File<FE, B>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<F, T> CastFrom<F> for T
where T: From<F>,

source§

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.
source§

impl<T, F> CastInto<F> for T
where F: CastFrom<T>,

source§

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<F> Match for F

source§

fn matches<T>(&self) -> bool
where T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<State, T> ToState<State> for T
where State: StateInstance, T: Clone + Into<State>,

source§

fn to_state(&self) -> State

source§

impl<F, T> TryCastFrom<F> for T
where T: CastFrom<F>,

source§

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.
source§

fn opt_cast_from(f: F) -> Option<T>

Returns Some(Self) if the source value can be cast into Self, otherwise None.
source§

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>
where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.
source§

impl<F, T> TryCastInto<T> for F
where T: TryCastFrom<F>,

source§

fn can_cast_into(&self) -> bool

Test if self can be cast into T.
source§

fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.
source§

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err>
where OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> ThreadSafe for T
where T: Send + Sync + 'static,