Struct gix_traverse::tree::Recorder

pub struct Recorder {
    pub records: Vec<Entry>,
    /* private fields */
}

A Visit implementation to record every observed change and keep track of the changed paths.

Recorders can also be instructed to track the filename only, or no location at all.

Fields

records: Vec<Entry>

The observed entries.

Implementations

impl Recorder

Builder

pub fn track_location(self, location: Option<Location>) -> Self

Obtain a copy of the currently tracked, full path of the entry.

impl Recorder

Access

pub fn path_clone(&self) -> BString

Obtain a copy of the currently tracked, full path of the entry.

pub fn path(&self) -> &BStr

Return the currently set path.

Trait Implementations

impl Clone for Recorder

fn clone(&self) -> Recorder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Recorder

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

Formats the value using the given formatter.

impl Default for Recorder

fn default() -> Self

Returns the “default value” for a type.

impl Visit for Recorder

fn pop_front_tracked_path_and_set_current(&mut self)

Sets the full path path in front of the queue so future calls to push and pop components affect it instead.

fn push_back_tracked_path_component(&mut self, component: &BStr)

Append a component to the end of a path, which may be empty.

fn push_path_component(&mut self, component: &BStr)

Append a component to the end of a path, which may be empty.

fn pop_path_component(&mut self)

Removes the last component from the path, which may leave it empty.

fn visit_tree(&mut self, entry: &EntryRef<'_>) -> Action

Observe a tree entry that is a tree and return an instruction whether to continue or not. Action::Skip can be used to prevent traversing it, for example if it’s known to the caller already.

fn visit_nontree(&mut self, entry: &EntryRef<'_>) -> Action

Observe a tree entry that is NO tree and return an instruction whether to continue or not. Action::Skip has no effect here.