Struct DocMoveResult 

pub struct DocMoveResult {
    pub doc_id: String,
    pub path: String,
    pub committed: bool,
    pub diffs: Option<Diffs>,
    pub dangling: Vec<InboundLink>,
    pub retargeted: Option<Retargeted>,
}

The result of docs_move.

Fields

doc_id: String

path: String

committed: bool

diffs: Option<Diffs>

With a dry run: the old path emptied, the new path filled, then any source the retarget_inbound rewrite would touch. None when committed.

dangling: Vec<InboundLink>

Inbound links still naming the old path after the call (with the retarget: the frontmatter relations, which are never rewritten).

retargeted: Option<Retargeted>

None when the retarget was opted out or nothing linked in; empty lists when it ran but only frontmatter relations linked in.

Implementations

impl DocMoveResult

pub fn to_json(&self) -> Value

{ doc, path, committed, diffs?, dangling, retargeted }.

Trait Implementations

impl Clone for DocMoveResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocMoveResult

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

Formats the value using the given formatter.

impl Eq for DocMoveResult

impl PartialEq for DocMoveResult

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DocMoveResult