Skip to main content

NodePages

Struct NodePages 

Source
pub struct NodePages<'a> { /* private fields */ }
Expand description

Page-based flat node array using Cell<Node> for interior mutability.

Nodes are allocated sequentially and addressed by flat u32 indices. Pages of PAGE_SIZE nodes each are arena-allocated on demand. Cell<Node> allows mutation through a shared reference, which is needed when the builder holds &mut to its own state but only & to the pages for sibling/parent fixup.

Implementations§

Source§

impl<'a> NodePages<'a>

Source

pub fn new(arena: &'a Bump) -> Self

Creates a new NodePages with the first page pre-allocated.

Source

pub fn alloc(&mut self) -> Result<u32, BufferDocumentError>

Allocates the next node slot and returns its flat index.

A new page is allocated when the current page is full.

§Errors

Returns BufferDocumentError::Overflow if the index would exceed u32::MAX - 1.

Source

pub fn get(&self, node_ref: u32) -> Node

Reads the node at the given flat index.

Source

pub fn set(&self, node_ref: u32, node: Node)

Writes a node at the given flat index (interior mutability via Cell).

Source

pub fn update<F: FnOnce(&mut Node)>(&self, node_ref: u32, f: F)

Read-modify-write a node at the given flat index.

Source

pub fn len(&self) -> u32

Returns the total number of allocated nodes.

Source

pub fn is_empty(&self) -> bool

Returns true if no nodes have been allocated.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for NodePages<'a>

§

impl<'a> !Send for NodePages<'a>

§

impl<'a> !Sync for NodePages<'a>

§

impl<'a> !UnwindSafe for NodePages<'a>

§

impl<'a> Freeze for NodePages<'a>

§

impl<'a> Unpin for NodePages<'a>

§

impl<'a> UnsafeUnpin for NodePages<'a>

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> ErasedDestructor for T
where T: 'static,

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> MaybeSendSync for T

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.