Skip to main content

HeaderNode

Struct HeaderNode 

Source
pub struct HeaderNode {
    pub tsn: Tsn,
    pub free_lists_tree_root_id: PageID,
    pub events_tree_root_id: PageID,
    pub tags_tree_root_id: PageID,
    pub next_page_id: PageID,
    pub next_position: Position,
    pub schema_version: u32,
    pub tracking_root_page_id: PageID,
}

Fields§

§tsn: Tsn§free_lists_tree_root_id: PageID§events_tree_root_id: PageID§tags_tree_root_id: PageID§next_page_id: PageID§next_position: Position§schema_version: u32

On-disk schema version for the header node

§tracking_root_page_id: PageID

Implementations§

Source§

impl HeaderNode

Source

pub fn calc_serialized_size(&self) -> usize

Writes the serialized HeaderNode into the provided buffer and returns the number of bytes written (52). The buffer must be at least 52 bytes long.

Source

pub fn serialize_into(&self, buf: &mut [u8]) -> DcbResult<usize>

Source

pub fn from_slice(slice: &[u8]) -> DcbResult<Self>

Deserializes a HeaderNode from a byte slice.

This function is strictly backward-compatible. It accepts legacy 48-byte layouts and dynamically defaults newer fields to 0 or empty if the provided slice is shorter than the current schema.

§Byte Layout

Core Header (Required - 48 bytes):

  • 00..08: tsn (u64)
  • 08..16: next_page_id (u64)
  • 16..24: free_lists_tree_root_id (u64)
  • 24..32: events_tree_root_id (u64)
  • 32..40: tags_tree_root_id (u64)
  • 40..48: next_position (u64)

Extensions (Optional):

  • 48..52: schema_version (u32, defaults to 0)
  • 52..54: flags (u16, defaults to empty)
  • 54..62: tracking_root_page_id (u64, parsed only if HAS_TRACKING_ROOT_ID flag is set, defaults to 0)
§Arguments
  • slice - The byte slice containing the serialized header data.
§Errors

Returns a DcbError::DeserializationError if:

  • The slice is smaller than the core 48 bytes.
  • Unrecognized bits are set in the flags field.
  • The HAS_TRACKING_ROOT_ID flag is present, but the slice is too short to contain the 8-byte ID.

Trait Implementations§

Source§

impl Clone for HeaderNode

Source§

fn clone(&self) -> HeaderNode

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 HeaderNode

Source§

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

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

impl Default for HeaderNode

Source§

fn default() -> Self

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

impl Eq for HeaderNode

Source§

impl PartialEq for HeaderNode

Source§

fn eq(&self, other: &HeaderNode) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HeaderNode

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.