Struct git_nomad::snapshot::Snapshot

pub struct Snapshot<'a, Ref> {
    pub local_branches: HashSet<Branch<'static>>,
    pub nomad_refs: Vec<NomadRef<'a, Ref>>,
    _private: (),
}

A point in time view of refs we care about. Snapshot is only for local branches and refs and thus is scoped under a specific User.

Fields

local_branches: HashSet<Branch<'static>>

The active branches in this clone that the user manipulates directly with git branch etc.

nomad_refs: Vec<NomadRef<'a, Ref>>

The refs that nomad manages to follow the local branches.

_private: ()

Force all callers to go through Snapshot::new which can validate invariants.

Implementations

impl<Ref> Snapshot<'_, Ref>

pub fn new<'a>( user: &'a User<'_>, local_branches: HashSet<Branch<'static>>, nomad_refs: Vec<NomadRef<'a, Ref>>, ) -> Snapshot<'a, Ref>

Smart constructor that enforces the “scoped under a specific User” invariant.

Panics

If nomad_refs points to a different User than the user passed in. This indicates serious programmer error.

impl<'a, Ref> Snapshot<'a, Ref>

pub fn prune_deleted_branches( self, host: &Host<'_>, remote_nomad_refs: &RemoteNomadRefSet, ) -> Vec<PruneFrom<'a, Ref>>

Find nomad host branches that can be pruned because:

1. The local branch they were based on no longer exists.
2. The remote branch they were based on no longer exists.

pub fn prune_by_hosts( self, host_filter: impl Fn(&Host<'_>) -> bool, ) -> Vec<PruneFrom<'a, Ref>>

Return all nomad branches for specific hosts.

pub fn sorted_hosts_and_branches( self, ) -> Vec<(Host<'a>, Vec<NomadRef<'a, Ref>>)>

Return all NomadRefs grouped by host in sorted order.