Struct nebari::transaction::TransactionManager

source · [−]

pub struct TransactionManager<Manager: FileManager> { /* private fields */ }

Expand description

A shared TransactionLog manager. Allows multiple threads to interact with a single transaction log.

Implementations

source

impl<Manager> TransactionManager<Manager> where
Manager: FileManager,

source

pub fn spawn(directory: &Path, context: Context<Manager>) -> Result<Self, Error>

Spawns a new transaction manager. The transaction manager runs its own thread that writes to the transaction log.

source

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8 ], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8 ]>>(
&self,
trees: I
) -> ManagedTransaction<Manager>

Creates a new transaction, exclusively locking trees. Will block the thread until the trees can be locked.

source

pub fn scan<Callback: FnMut(LogEntry<'static>) -> bool>(
 &self,
 range: impl RangeBounds<TransactionId>,
 callback: Callback
) -> Result<(), Error>

Scans the transaction log for entries with ids within range. Invokes callback for each entry found. The scan will always scan forwards starting with the lowest ID matching the range.

source

pub fn transaction_was_successful(
&self,
transaction_id: TransactionId
) -> Result<bool, Error>

Returns true if the transaction id was recorded in the transaction log. This method caches

source

pub fn transaction_position(
&self,
transaction_id: TransactionId
) -> Result<Option<u64>, Error>

Returns the location on disk of the transaction, if found.

source

pub fn state(&self) -> &State

Returns the current state of the transaction log.

Methods from Deref<Target = State>

source

pub fn current_transaction_id(&self) -> Option<TransactionId>

Returns the last successfully written transaction id, or None if no transactions have been recorded yet.

source

pub fn next_transaction_id(&self) -> TransactionId

Returns the next transaction id that will be used.

source

pub fn path(&self) -> &Path

Returns the path to the file.

source

pub fn len(&self) -> u64

Returns the current length of the log.

source

pub fn is_empty(&self) -> bool

Returns if the log is empty.

source

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8 ], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8 ]>>(
&self,
trees: I
) -> TransactionHandle

Creates a new transaction, exclusively locking trees. Will block the thread until the trees can be locked.

Trait Implementations

source

impl<Manager: Clone + FileManager> Clone for TransactionManager<Manager>

source

fn clone(&self) -> TransactionManager<Manager>

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<Manager: Debug + FileManager> Debug for TransactionManager<Manager>

source

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

Formats the value using the given formatter. Read more

source

impl<Manager: FileManager> Deref for TransactionManager<Manager>

type Target = State

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations

impl<Manager> !RefUnwindSafe for TransactionManager<Manager>

impl<Manager> Send for TransactionManager<Manager>

impl<Manager> Sync for TransactionManager<Manager>

impl<Manager> Unpin for TransactionManager<Manager> where
Manager: Unpin,

impl<Manager> !UnwindSafe for TransactionManager<Manager>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

pub 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<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

pub 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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct nebari::transaction::TransactionManager

Implementations

impl<Manager> TransactionManager<Manager> where Manager: FileManager,

pub fn spawn(directory: &Path, context: Context<Manager>) -> Result<Self, Error>

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8]>>( &self, trees: I) -> ManagedTransaction<Manager>

pub fn scan<Callback: FnMut(LogEntry<'static>) -> bool>( &self, range: impl RangeBounds<TransactionId>, callback: Callback) -> Result<(), Error>

pub fn transaction_was_successful( &self, transaction_id: TransactionId) -> Result<bool, Error>

pub fn transaction_position( &self, transaction_id: TransactionId) -> Result<Option<u64>, Error>

pub fn state(&self) -> &State

Methods from Deref<Target = State>

pub fn current_transaction_id(&self) -> Option<TransactionId>

pub fn next_transaction_id(&self) -> TransactionId

pub fn path(&self) -> &Path

pub fn len(&self) -> u64

pub fn is_empty(&self) -> bool

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8]>>( &self, trees: I) -> TransactionHandle

Trait Implementations

impl<Manager: Clone + FileManager> Clone for TransactionManager<Manager>

fn clone(&self) -> TransactionManager<Manager>

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

impl<Manager: Debug + FileManager> Debug for TransactionManager<Manager>

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

impl<Manager: FileManager> Deref for TransactionManager<Manager>

type Target = State

fn deref(&self) -> &Self::Target

Auto Trait Implementations

impl<Manager> !RefUnwindSafe for TransactionManager<Manager>

impl<Manager> Send for TransactionManager<Manager>

impl<Manager> Sync for TransactionManager<Manager>

impl<Manager> Unpin for TransactionManager<Manager> where Manager: Unpin,

impl<Manager> !UnwindSafe for TransactionManager<Manager>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<Manager> TransactionManager<Manager> where
Manager: FileManager,

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8 ], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8 ]>>(
&self,
trees: I
) -> ManagedTransaction<Manager>

pub fn scan<Callback: FnMut(LogEntry<'static>) -> bool>(
&self,
range: impl RangeBounds<TransactionId>,
callback: Callback
) -> Result<(), Error>

pub fn transaction_was_successful(
&self,
transaction_id: TransactionId
) -> Result<bool, Error>

pub fn transaction_position(
&self,
transaction_id: TransactionId
) -> Result<Option<u64>, Error>

pub fn new_transaction<'a, I: IntoIterator<Item = &'a [u8 ], IntoIter = II>, II: ExactSizeIterator<Item = &'a [u8 ]>>(
&self,
trees: I
) -> TransactionHandle

impl<Manager> Unpin for TransactionManager<Manager> where
Manager: Unpin,

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

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

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

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

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

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

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

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