Enum nebari::tree::Pointer

source · [−]

pub enum Pointer<Index, ReducedIndex> {
    OnDisk(u64),
    Loaded {
        previous_location: Option<u64>,
        entry: Box<BTreeEntry<Index, ReducedIndex>>,
    },
}

Expand description

A pointer to a location on-disk. May also contain the node already loaded.

Variants

`OnDisk(u64)`

The position on-disk of the node.

`Loaded`

Fields

previous_location: Option<u64>

The position on-disk of the node, if it was previously saved.

entry: Box<BTreeEntry<Index, ReducedIndex>>

The loaded B-Tree entry.

An in-memory node that may have previously been saved on-disk.

Implementations

source

impl<Index: BinarySerialization + Debug + Clone + 'static, ReducedIndex: BinarySerialization + Debug + Clone + 'static> Pointer<Index, ReducedIndex>

source

pub fn load(
 &mut self,
 file: &mut dyn File,
 validate_crc: bool,
 vault: Option<&dyn AnyVault>,
 cache: Option<&ChunkCache>,
 current_order: Option<usize>
) -> Result<(), Error>

Attempts to load the node from disk. If the node is already loaded, this function does nothing.

source

pub fn get(&mut self) -> Option<&BTreeEntry<Index, ReducedIndex>>

Returns the previously-load()ed entry.

source

pub fn get_mut(&mut self) -> Option<&mut BTreeEntry<Index, ReducedIndex>>

Returns the previously-load()ed entry as a mutable reference.

source

pub fn position(&self) -> Option<u64>

Returns the position on-disk of the node being pointed at, if the node has been saved before.

source

pub fn map_loaded_entry<Output, CallerError: Display + Debug, Cb: FnOnce(&BTreeEntry<Index, ReducedIndex>, &mut dyn File) -> Result<Output, AbortError<CallerError>>>(
 &self,
 file: &mut dyn File,
 vault: Option<&dyn AnyVault>,
 cache: Option<&ChunkCache>,
 current_order: Option<usize>,
 callback: Cb
) -> Result<Output, AbortError<CallerError>>

Loads the pointed at node, if necessary, and invokes callback with the loaded node. This is useful in situations where the node isn’t needed to be accessed mutably.

Trait Implementations

source

impl<Index: Clone, ReducedIndex: Clone> Clone for Pointer<Index, ReducedIndex>

source

fn clone(&self) -> Pointer<Index, ReducedIndex>

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<Index: Debug, ReducedIndex: Debug> Debug for Pointer<Index, ReducedIndex>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<Index, ReducedIndex> RefUnwindSafe for Pointer<Index, ReducedIndex> where
Index: RefUnwindSafe,
ReducedIndex: RefUnwindSafe,

impl<Index, ReducedIndex> Send for Pointer<Index, ReducedIndex> where
Index: Send,
ReducedIndex: Send,

impl<Index, ReducedIndex> Sync for Pointer<Index, ReducedIndex> where
Index: Sync,
ReducedIndex: Sync,

impl<Index, ReducedIndex> Unpin for Pointer<Index, ReducedIndex>

impl<Index, ReducedIndex> UnwindSafe for Pointer<Index, ReducedIndex> where
Index: UnwindSafe,
ReducedIndex: UnwindSafe,

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

Enum nebari::tree::Pointer

Variants

OnDisk(u64)

Loaded

Fields

Implementations

impl<Index: BinarySerialization + Debug + Clone + 'static, ReducedIndex: BinarySerialization + Debug + Clone + 'static> Pointer<Index, ReducedIndex>

pub fn load( &mut self, file: &mut dyn File, validate_crc: bool, vault: Option<&dyn AnyVault>, cache: Option<&ChunkCache>, current_order: Option<usize>) -> Result<(), Error>

pub fn get(&mut self) -> Option<&BTreeEntry<Index, ReducedIndex>>

pub fn get_mut(&mut self) -> Option<&mut BTreeEntry<Index, ReducedIndex>>

pub fn position(&self) -> Option<u64>

Trait Implementations

impl<Index: Clone, ReducedIndex: Clone> Clone for Pointer<Index, ReducedIndex>

fn clone(&self) -> Pointer<Index, ReducedIndex>

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

impl<Index: Debug, ReducedIndex: Debug> Debug for Pointer<Index, ReducedIndex>

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

Auto Trait Implementations

impl<Index, ReducedIndex> RefUnwindSafe for Pointer<Index, ReducedIndex> where Index: RefUnwindSafe, ReducedIndex: RefUnwindSafe,

impl<Index, ReducedIndex> Send for Pointer<Index, ReducedIndex> where Index: Send, ReducedIndex: Send,

impl<Index, ReducedIndex> Sync for Pointer<Index, ReducedIndex> where Index: Sync, ReducedIndex: Sync,

impl<Index, ReducedIndex> Unpin for Pointer<Index, ReducedIndex>

impl<Index, ReducedIndex> UnwindSafe for Pointer<Index, ReducedIndex> where Index: UnwindSafe, ReducedIndex: UnwindSafe,

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>

`OnDisk(u64)`

`Loaded`

pub fn load(
&mut self,
file: &mut dyn File,
validate_crc: bool,
vault: Option<&dyn AnyVault>,
cache: Option<&ChunkCache>,
current_order: Option<usize>
) -> Result<(), Error>

impl<Index, ReducedIndex> RefUnwindSafe for Pointer<Index, ReducedIndex> where
Index: RefUnwindSafe,
ReducedIndex: RefUnwindSafe,

impl<Index, ReducedIndex> Send for Pointer<Index, ReducedIndex> where
Index: Send,
ReducedIndex: Send,

impl<Index, ReducedIndex> Sync for Pointer<Index, ReducedIndex> where
Index: Sync,
ReducedIndex: Sync,

impl<Index, ReducedIndex> UnwindSafe for Pointer<Index, ReducedIndex> where
Index: UnwindSafe,
ReducedIndex: UnwindSafe,

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>,