Skip to main content

AtomicWriter

Struct AtomicWriter 

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

Atomic-write fixture: open a temp file, hand the caller a writer, then either fsync + rename it onto dest or unlink it on error.

The pattern in commit:

  1. Caller writes payload via Self::write_all.
  2. Caller invokes Self::commit.
  3. We flush + sync_all + close, then rename(2) onto the destination.
  4. On error in step 3, the UnlinkOnDrop guard removes the temp file.

The cross-FS pre-flight check runs in Self::open; subsequent commit cannot fail with EXDEV because we’ve already validated.

Implementations§

Source§

impl AtomicWriter

Source

pub fn open(dest: &Path) -> Result<Self, SnapshotError>

Open the temp file for writing.

Pre-flight: validate that the temp dir and destination dir live on the same filesystem (cross-FS rename cannot be atomic).

§Errors

SnapshotError::AtomicCommitCrossFs for the cross-FS case; SnapshotError::Io for an open / mkdir / stat failure.

Source

pub fn temp_path(&self) -> &Path

The temp-file path (visible during writing, before commit).

Source

pub fn dest_path(&self) -> &Path

The destination path the commit will produce.

Source

pub fn file_mut(&mut self) -> &mut File

Borrow the underlying file for direct writes (used by the streaming envelope

  • memory file paths).
Source

pub fn commit(self) -> Result<(), SnapshotError>

fsync the temp file, drop the writer, and rename(2) it onto the destination.

§Errors

SnapshotError::AtomicCommitFailed for the rename failure (temp file is unlinked); SnapshotError::Io for an fsync failure (temp file is also unlinked).

Trait Implementations§

Source§

impl Debug for AtomicWriter

Source§

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

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

impl Write for AtomicWriter

Source§

fn write(&mut self, buf: &[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> 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, 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