Struct WalkOptions 

pub struct WalkOptions {
    pub starting_points: Vec<VoidCid>,
    pub max_commits: Option<usize>,
    pub order: WalkOrder,
}

Options for commit traversal.

Fields

starting_points: Vec<VoidCid>

Starting commit CIDs for the walk.

max_commits: Option<usize>

Maximum number of commits to visit (None = unlimited).

order: WalkOrder

Walk order (default: HeadToRoot).

Implementations

impl WalkOptions

pub fn from_head(void_dir: &Utf8Path) -> Result<Self>

Create walk options starting from HEAD.

pub fn from_all_refs(void_dir: &Utf8Path) -> Result<Self>

Create walk options starting from HEAD and all branch heads.

This is useful for operations that need complete coverage of all commits in the repository, including those on feature branches.

pub fn from_commit(commit_cid: VoidCid) -> Self

Create walk options starting from a specific commit.

pub fn from_commits(commit_cids: Vec<VoidCid>) -> Self

Create walk options starting from multiple commits.

pub fn with_max_commits(self, max: usize) -> Self

Set maximum number of commits to visit.

pub fn with_order(self, order: WalkOrder) -> Self

Set the walk order.

Default is HeadToRoot (BFS from newest to oldest). Use RootToHead for topological traversal from oldest to newest.

Trait Implementations

impl Clone for WalkOptions

fn clone(&self) -> WalkOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalkOptions

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

Formats the value using the given formatter.