Skip to main content

AtomicGuard

Struct AtomicGuard 

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

An RAII guard that backs up a file before mutation and restores it on drop unless explicitly committed.

The backup file is named {original}.bak.{epoch_nanos}.{pid} and lives alongside the original. This mirrors the pattern used by the shell-based atomic helpers in temp-reference-scripts/lib/atomic.sh.

§Behavior

  • new(path): Creates a backup copy of the file. If the file does not exist, no backup is created and the guard is a no-op on drop.
  • commit(self): Removes the backup file and consumes the guard so that Drop does not run the restore logic.
  • Drop: If the guard was not committed and a backup exists, restores the original file from the backup.

Implementations§

Source§

impl AtomicGuard

Source

pub fn new(path: &Path) -> Result<Self, SoukError>

Creates a new AtomicGuard for the file at path.

If the file exists, a timestamped backup is created immediately. If the file does not exist (e.g., it will be created fresh by the operation), no backup is made and the guard becomes a no-op on drop.

§Errors

Returns SoukError::Io if the file exists but cannot be copied.

Source

pub fn backup_path(&self) -> Option<&Path>

Returns the path to the backup file, if one was created.

Source

pub fn original_path(&self) -> &Path

Returns the path to the original file being guarded.

Source

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

Commits the operation, removing the backup file.

This consumes the guard so that Drop will not attempt to restore the original file. Call this after the mutation has been verified as successful.

§Errors

Returns SoukError::Io if the backup file exists but cannot be removed. Even on error, the guard is marked as committed so that Drop will not attempt a restore (the mutation already succeeded).

Trait Implementations§

Source§

impl Drop for AtomicGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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