Skip to main content

Frame

Struct Frame 

Source
pub struct Frame { /* private fields */ }
Expand description

A buffer frame: a PAGE_SIZE block of memory with metadata for buffer management.

§Safety

The data pointer is allocated via std::alloc and must be freed via Frame::drop. Access to the data must be coordinated through:

  • pin_count > 0 (frame is in use, cannot be evicted)
  • latch (read/write access to the page data)

Implementations§

Source§

impl Frame

Source

pub fn new() -> Self

Allocate a new frame with zeroed PAGE_SIZE memory.

Source

pub unsafe fn data(&self) -> &[u8]

Get a shared (read-only) reference to the page data.

§Safety

Caller must hold a shared latch or pin and ensure no writer exists.

Source

pub unsafe fn data_mut(&self) -> &mut [u8]

Get an exclusive (mutable) reference to the page data.

§Safety

Caller must hold an exclusive latch. The &self signature is intentional: Frame uses interior mutability via a raw pointer, coordinated by pin_count and latch.

Source

pub fn page_id(&self) -> PageId

Get the page ID currently loaded in this frame.

Source

pub fn set_page_id(&self, pid: PageId)

Set the page ID for this frame.

Source

pub fn pin_count(&self) -> u32

Get the current pin count.

Source

pub fn pin(&self) -> u32

Increment the pin count.

Source

pub fn unpin(&self) -> u32

Decrement the pin count.

Source

pub fn is_pinned(&self) -> bool

Check if the frame is pinned.

Source

pub fn is_dirty(&self) -> bool

Check if the frame is dirty.

Source

pub fn set_dirty(&self)

Mark the frame as dirty.

Source

pub fn clear_dirty(&self)

Clear the dirty flag.

Source

pub fn is_recently_used(&self) -> bool

Check if the frame was recently used.

Source

pub fn set_recently_used(&self)

Mark the frame as recently used.

Source

pub fn clear_recently_used(&self)

Clear the recently-used flag (second-chance eviction).

Source

pub fn latch(&self) -> &RwLatch

Get a reference to the latch.

Source

pub fn reset(&self)

Reset the frame to an empty state (for after eviction).

Source

pub fn has_valid_page(&self) -> bool

Check if this frame holds a valid page.

Trait Implementations§

Source§

impl Default for Frame

Source§

fn default() -> Self

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

impl Drop for Frame

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Frame

Source§

impl Sync for Frame

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

Source§

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<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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
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