Skip to main content

PageStore

Struct PageStore 

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

Page store: maps logical page IDs to on-disk locations, with optional at-rest encryption via EncryptionContext.

§On-disk layout

When encryption is disabled (passthrough mode), each page occupies exactly page_size bytes at offset page_id * page_size.

When encryption is enabled, each page occupies page_size + 40 bytes (the “encrypted stride”):

┌────────────────────────┬───────────────────────────────────┐
│  nonce (24 bytes)      │  ciphertext + auth tag            │
│                        │  (page_size + 16 bytes)           │
└────────────────────────┴───────────────────────────────────┘
total: page_size + 40 bytes per page slot

The encryption stride ensures that a file opened without a key cannot be accidentally decoded as raw pages (sizes won’t align).

Implementations§

Source§

impl PageStore

Source

pub fn open(path: &Path) -> Result<Self>

Open (or create) a page store at path with the given page_size and no encryption.

Use PageStore::open_encrypted to enable at-rest encryption.

Source

pub fn open_with_page_size(path: &Path, page_size: usize) -> Result<Self>

Open (or create) a page store with the given page size and no encryption.

Source

pub fn open_encrypted( path: &Path, page_size: usize, key: [u8; 32], ) -> Result<Self>

Open (or create) an encrypted page store.

key — 32-byte master encryption key (XChaCha20-Poly1305).

If the file already exists and was written with a different key, the first read_page call will return Error::EncryptionAuthFailed.

Source

pub fn read_page(&self, id: PageId, buf: &mut [u8]) -> Result<()>

Read page id into buf.

buf must be exactly page_size bytes.

§Errors
Source

pub fn write_page(&self, id: PageId, buf: &[u8]) -> Result<()>

Write buf as page id.

buf must be exactly page_size bytes.

§Errors
Source

pub fn fsync(&self) -> Result<()>

Flush and fsync the backing file to durable storage.

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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