Skip to main content

ChildReference

Struct ChildReference 

Source
pub struct ChildReference {
    pub key: Vec<u8>,
    pub lsn: Lsn,
    pub state: SlotState,
}
Expand description

A reference in the tree from parent to child.

Contains a key, LSN (on-disk location), and state byte for tracking deletion and dirty status. This structure is used primarily for the tree root reference, though in it’s also used within IN slot arrays.

In the Noxu DB Rust port, individual IN/BIN slot storage is separate from ChildReference, but the concepts are similar.

Fields§

§key: Vec<u8>

The key identifying this child in the parent’s key range.

§lsn: Lsn

The LSN of the child node on disk, or NULL_LSN if not yet logged.

§state: SlotState

State flags for this reference (dirty, known-deleted, etc.).

Implementations§

Source§

impl ChildReference

Source

pub fn new(key: Vec<u8>, lsn: Lsn, state: SlotState) -> Self

Creates a new ChildReference.

§Arguments
  • key - The key identifying this child
  • lsn - The LSN of the child node on disk
  • state - Initial state flags
Source

pub fn new_with_key_and_lsn(key: Vec<u8>, lsn: Lsn) -> Self

Creates a new ChildReference with empty state.

§Arguments
  • key - The key identifying this child
  • lsn - The LSN of the child node on disk
Source

pub fn is_known_deleted(&self) -> bool

Returns true if the known-deleted flag is set.

Source

pub fn set_known_deleted(&mut self)

Sets the known-deleted flag.

Source

pub fn clear_known_deleted(&mut self)

Clears the known-deleted flag.

Source

pub fn is_pending_deleted(&self) -> bool

Returns true if the pending-deleted flag is set.

Source

pub fn set_pending_deleted(&mut self)

Sets the pending-deleted flag.

Source

pub fn clear_pending_deleted(&mut self)

Clears the pending-deleted flag.

Source

pub fn is_dirty(&self) -> bool

Returns true if the dirty flag is set.

Source

pub fn set_dirty(&mut self)

Sets the dirty flag.

Source

pub fn clear_dirty(&mut self)

Clears the dirty flag.

Source

pub fn is_embedded_ln(&self) -> bool

Returns true if the embedded-LN flag is set.

Source

pub fn set_embedded_ln(&mut self)

Sets the embedded-LN flag.

Source

pub fn clear_transient_bits(&mut self)

Clears all transient state bits (not persisted to disk).

Trait Implementations§

Source§

impl Clone for ChildReference

Source§

fn clone(&self) -> ChildReference

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChildReference

Source§

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

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

impl Default for ChildReference

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<T> ToOwned for T
where T: Clone,

Source§

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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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.