Struct tinychain::fs::Dir

source · [−]

pub struct Dir { /* private fields */ }

Expand description

A filesystem directory.

Implementations

impl Dir

pub fn new(cache: DirLock<CacheBlock>) -> Self

pub fn load<'a>(
cache: DirLock<CacheBlock>,
txn_id: TxnId
) -> TCBoxTryFuture<'a, Self>

pub async fn get_or_create_dir(
    &self,
    txn_id: TxnId,
    name: PathSegment
) -> TCResult<Self>

Trait Implementations

impl Clone for Dir

fn clone(&self) -> Dir

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

impl Dir for Dir

type File = FileEntry

The type of a file entry in this Dir

type FileClass = StateType

The Class of a file stored in this Dir

fn contains<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    name: &'life1 PathSegment
) -> Pin<Box<dyn Future<Output = TCResult<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Return true if this directory has an entry at the given PathSegment.

fn create_dir<'life0, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    name: PathSegment
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,

Create a new Dir.

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

Create a new Dir with a new unique ID.

fn create_file<'life0, 'async_trait, C, F, B>(
    &'life0 self,
    txn_id: TxnId,
    file_id: Id,
    class: C
) -> Pin<Box<dyn Future<Output = TCResult<F>> + Send + 'async_trait>> where
    C: Copy + Send + Display,
    StateType: From<C>,
    FileEntry: AsType<F>,
    F: File<B>,
    B: BlockData,
    C: 'async_trait,
    F: 'async_trait,
    B: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait,

Create a new Self::File.

fn create_file_unique<'life0, 'async_trait, C, F, B>(
    &'life0 self,
    txn_id: TxnId,
    class: C
) -> Pin<Box<dyn Future<Output = TCResult<F>> + Send + 'async_trait>> where
    C: Copy + Send + Display,
    StateType: From<C>,
    FileEntry: AsType<F>,
    F: File<B>,
    B: BlockData,
    C: 'async_trait,
    F: 'async_trait,
    B: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait,

Create a new Self::File with a new unique ID.

fn get_dir<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: TxnId,
    name: &'life1 PathSegment
) -> Pin<Box<dyn Future<Output = TCResult<Option<Self>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Look up a subdirectory of this Dir.

fn get_file<'life0, 'life1, 'async_trait, F, B>(
    &'life0 self,
    txn_id: TxnId,
    file_id: &'life1 Id
) -> Pin<Box<dyn Future<Output = TCResult<Option<F>>> + Send + 'async_trait>> where
    FileEntry: AsType<F>,
    F: File<B>,
    B: BlockData,
    F: 'async_trait,
    B: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Get a Self::File in this Dir.

impl Display for Dir

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

Formats the value using the given formatter. Read more

impl<'en> IntoView<'en, Dir> for BlockChain

type Txn = Txn

type View = (Schema, SeqStream<Result<(Bytes, MapStream<TxnId, Result<SeqStream<Result<MutationView<'en>, TCError>, Pin<Box<dyn Stream<Item = Result<MutationView<'en>, TCError>> + Unpin + Send + 'en, Global>>>, TCError>, Pin<Box<dyn Stream<Item = (TxnId, Result<SeqStream<Result<MutationView<'en>, TCError>, Pin<Box<dyn Stream<Item = Result<MutationView<'en>, TCError>> + Unpin + Send + 'en, Global>>>, TCError>)> + Unpin + Send + 'en, Global>>>), TCError>, Pin<Box<dyn Stream<Item = Result<(Bytes, MapStream<TxnId, Result<SeqStream<Result<MutationView<'en>, TCError>, Pin<Box<dyn Stream<Item = Result<MutationView<'en>, TCError>> + Unpin + Send + 'en, Global>>>, TCError>, Pin<Box<dyn Stream<Item = (TxnId, Result<SeqStream<Result<MutationView<'en>, TCError>, Pin<Box<dyn Stream<Item = Result<MutationView<'en>, TCError>> + Unpin + Send + 'en, Global>>>, TCError>)> + Unpin + Send + 'en, Global>>>), TCError>> + Unpin + Send + 'en, Global>>>)

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for SubjectCollection

type Txn = Txn

type View = StateView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for State

type Txn = Txn

type View = StateView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for TCStream

type Txn = Txn

type View = SeqStream<Result<StateView<'en>, TCError>, Pin<Box<dyn Stream<Item = Result<StateView<'en>, TCError>> + Unpin + Send + 'en, Global>>>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for SubjectMap

type Txn = Txn

type View = StateView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for Subject

type Txn = Txn

type View = StateView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for SyncChain

type Txn = Txn

type View = (Schema, StateView<'en>)

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for Chain

type Txn = Txn

type View = ChainView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for Closure

type Txn = Txn

type View = (HashMap<Id, StateView<'en>, RandomState>, OpDef )

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for Collection

type Txn = Txn

type View = CollectionView<'en>

fn into_view<'async_trait>(
    self,
    txn: Self::Txn
) -> Pin<Box<dyn Future<Output = TCResult<Self::View>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for InstanceExt<State>

type Txn = Txn

type View = InstanceView<'en>

fn into_view<'async_trait>(
    self,
    txn: Txn
) -> Pin<Box<dyn Future<Output = TCResult<InstanceView<'en>>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl<'en> IntoView<'en, Dir> for Object

type Txn = Txn

type View = ObjectView<'en>

fn into_view<'async_trait>(
    self,
    txn: Txn
) -> Pin<Box<dyn Future<Output = TCResult<ObjectView<'en>>> + Send + 'async_trait>> where
    Self: 'async_trait,

Return a View which can be encoded with en::IntoStream.

impl Persist<Dir> for BlockChain

type Schema = Schema

type Store = Dir

type Txn = Txn

fn schema(&self) -> &Schema

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 Txn,
    schema: Schema,
    dir: Dir
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,

Load a saved state from persistent storage.

impl Persist<Dir> for SyncChain

type Schema = Schema

type Store = Dir

type Txn = Txn

fn schema(&self) -> &Schema

Return the schema of this persistent state.

fn load<'life0, 'async_trait>(
    txn: &'life0 Txn,
    schema: Self::Schema,
    dir: Dir
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,

Load a saved state from persistent storage.

impl Store for Dir

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

Return true if this store contains no data as of the given TxnId.

impl Transact for Dir

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

Commit this transaction.

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

Delete any version data specific to this transaction.

impl Transaction<Dir> for Txn

fn id(&self) -> &TxnId

The TxnId of this transaction context.

fn context(&self) -> &Dir

Borrow the fs::Dir of this transaction context.

fn into_context(self) -> Dir

Consume this Txn and return its fs::Dir.

fn subcontext<'life0, 'async_trait>(
    &'life0 self,
    id: Id
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,

Return a transaction subcontext with its own fs::Dir.

fn subcontext_tmp<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait,

Return a transaction subcontext with its own unique fs::Dir.

Auto Trait Implementations

impl !RefUnwindSafe for Dir

impl Send for Dir

impl Sync for Dir

impl Unpin for Dir

impl !UnwindSafe for Dir

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.

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

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · 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.

impl<F> Match for F

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

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

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

fn can_cast_from(&F) -> bool

Test if value can be cast into Self.

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

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

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.

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

fn can_cast_into(&self) -> bool

Test if self can be cast into T.

fn opt_cast_into(self) -> Option<T>

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

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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · 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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more