Skip to main content

DurableFileCacheWriter

Struct DurableFileCacheWriter 

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

File writer that synchronizes and releases completed page-cache windows.

Implementations§

Source§

impl DurableFileCacheWriter

Source

pub fn new(file: File) -> Result<Self>

Wrap file with the default 1 GiB durable cache window.

§Errors

Returns an error when the current descriptor offset cannot be observed.

Source

pub fn with_window_bytes(file: File, window_bytes: NonZeroU64) -> Result<Self>

Wrap file with an explicit non-zero durable cache window.

§Errors

Returns an error when the current descriptor offset cannot be observed.

Source

pub fn with_window_bytes_checked( file: File, window_bytes: NonZeroU64, setup_check: impl FnOnce() -> Result<()>, ) -> Result<Self>

Wrap file and run one caller-supplied setup check after observing the real descriptor offset but before constructing the writer.

This exists so higher layers can deterministically exercise constructor failure without bypassing the actual descriptor setup path.

§Errors

Returns an error when offset observation or setup_check fails.

Source

pub fn sync_all_and_release(&mut self) -> Result<()>

Complete the final durability barrier and release its remaining cache window.

§Errors

Returns an error if synchronization or a supported cache-release request fails.

Source

pub fn file(&self) -> &File ⓘ

Borrow the underlying file.

Source

pub const fn evidence(&self) -> FileCacheReleaseEvidence

Return content-free synchronization and cache-release evidence.

Source

pub const fn window_bytes(&self) -> NonZeroU64

Return this writer’s configured synchronization/release window.

Source

pub fn into_file(self) -> File ⓘ

Consume the writer and return its underlying file.

Trait Implementations§

Source§

impl Debug for DurableFileCacheWriter

Source§

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

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

impl Write for DurableFileCacheWriter

Source§

fn write(&mut self, buffer: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

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, 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.