Struct FlushPlan

Source

pub struct FlushPlan {
    pub deletes: Vec<PathBuf>,
    pub renames: Vec<(PathBuf, PathBuf)>,
    pub writes: Vec<(PathBuf, String)>,
    pub retired_write: Option<(PathBuf, String)>,
    pub legacy_remove: Option<PathBuf>,
}

Expand description

What a flush must persist, as absolute paths and rendered text — computed without touching the filesystem so any backend can execute it.

Fields§

§deletes: Vec<PathBuf>

Document files to remove (a doc was deleted/closed/retired).

§renames: Vec<(PathBuf, PathBuf)>

Document files to move (from, to) after a layout/status change.

§writes: Vec<(PathBuf, String)>

Document files to (re)write (path, canonical text).

§retired_write: Option<(PathBuf, String)>

The retired ledger to (re)write (_retired.md path, serialized text).

§legacy_remove: Option<PathBuf>

A legacy _retired.txt to delete (migrated to _retired.md).

Trait Implementations§

Source §

impl Debug for FlushPlan

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for FlushPlan

Source §

fn default() -> FlushPlan

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for FlushPlan

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §