Record

Struct Record 

Source
pub struct Record<const FILE_LOCK: bool> { /* private fields */ }
Expand description

A record of file operations maintained in the graveyard directory

§Type Parameters

  • FILE_LOCK - When true, exclusive file locks are acquired when opening the record file for reading or writing. This prevents concurrent access from multiple processes. When false, no file locking is performed - which is used for testing.

Implementations§

Source§

impl<const FILE_LOCK: bool> Record<FILE_LOCK>

Source

pub fn new(graveyard: &Path) -> Self

Source

pub fn open(&self) -> Result<File, Error>

Source

pub fn get_last_bury(&self) -> Result<PathBuf, Error>

Return the path in the graveyard of the last file to be buried. As a side effect, any valid last files that are found in the record but not on the filesystem are removed from the record.

Source

pub fn log_exhumed_graves( &self, graves_to_exhume: &[PathBuf], ) -> Result<(), Error>

Source

pub fn lines_of_graves<'a>( &'a self, graves: &'a [PathBuf], ) -> impl Iterator<Item = String> + 'a

Takes a vector of grave paths and returns the respective lines in the record

Source

pub fn seance<'a>( &'a self, gravepath: &'a PathBuf, ) -> Result<impl Iterator<Item = RecordItem> + 'a>

Returns an iterator over all graves in the record that are under gravepath

Source

pub fn write_log( &self, source: impl AsRef<Path>, dest: impl AsRef<Path>, ) -> Result<()>

Write deletion history to record

Trait Implementations§

Source§

impl<const FILE_LOCK: bool> Clone for Record<FILE_LOCK>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const FILE_LOCK: bool> Debug for Record<FILE_LOCK>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const FILE_LOCK: bool> Freeze for Record<FILE_LOCK>

§

impl<const FILE_LOCK: bool> RefUnwindSafe for Record<FILE_LOCK>

§

impl<const FILE_LOCK: bool> Send for Record<FILE_LOCK>

§

impl<const FILE_LOCK: bool> Sync for Record<FILE_LOCK>

§

impl<const FILE_LOCK: bool> Unpin for Record<FILE_LOCK>

§

impl<const FILE_LOCK: bool> UnwindSafe for Record<FILE_LOCK>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.