Struct PageGuard 

pub struct PageGuard { /* private fields */ }

A pin on a cached page.

While a PageGuard is alive the page stays resident and unevictable. Read the page with read and write it with write; taking a write guard marks the page dirty. Dropping the PageGuard releases the pin.

Implementations

impl PageGuard

pub fn id(&self) -> PageId

The id of the pinned page.

pub fn is_dirty(&self) -> bool

Whether the page has unflushed modifications.

pub fn read(&self) -> PageRef<'_>

Borrow the page for reading. Multiple readers of the same page proceed concurrently.

pub fn write(&self) -> PageMut<'_>

Borrow the page for writing, marking it dirty.

The page is recorded dirty as soon as the write guard is taken, so it will be flushed even if the actual mutation is conditional.

Trait Implementations

impl Debug for PageGuard

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

Formats the value using the given formatter.

impl Drop for PageGuard

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.