Struct RenameBuilder 

pub struct RenameBuilder { /* private fields */ }

Build a rename mutation. The single record at <folder>/<from>.md is renamed to <folder>/<to>.md, and every [[wikilink]] across the vault pointing at from is rewritten to point at to.

Handled wikilink shapes: [[from]], [[from|alias]], [[from#section]], [[from#section|alias]].

Implementations

impl RenameBuilder

pub fn new( folder: impl Into<String>, from: impl Into<String>, to: impl Into<String>, ) -> Self

pub fn write_options(self, opts: WriteOptions) -> Self

Replace the writer::WriteOptions used by execute.

pub fn fsync(self, yes: bool) -> Self

Convenience: enable durable rename + backlink rewrites (fsync every modified file’s data and every modified directory’s dirent).

pub fn plan(&self, vault: &Vault) -> Result<MutationReport>

pub fn execute(self, vault: &Vault) -> Result<MutationReport>

Trait Implementations

impl Clone for RenameBuilder

fn clone(&self) -> RenameBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenameBuilder

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

Formats the value using the given formatter.