Skip to main content

RepositoryIdentity

Struct RepositoryIdentity 

Source
pub struct RepositoryIdentity { /* private fields */ }
Expand description

The repository a command is operating on, and every work tree git has registered for it.

Built once per command and passed around. A handful of subprocesses go into it and no more: the identity questions, one worktree list, and the trunk lookups.

Implementations§

Source§

impl RepositoryIdentity

Source

pub fn discover(start: &Path) -> Result<Self>

Resolve the repository from any directory inside any of its work trees.

Source

pub fn refresh(&mut self) -> Result<()>

Re-read the registered work trees. Under the lock, before a mutation, because the topology may have changed since discovery.

Source

pub fn git_common_dir(&self) -> &ResolvedPath

The common git directory every work tree of this repository shares. It is the repository’s identity: two paths belong to one repository exactly when this matches.

Source

pub fn primary_worktree(&self) -> &ResolvedPath

The primary checkout — the main work tree, never a linked one, whatever directory the command was run from.

Source

pub fn current_worktree(&self) -> &ResolvedPath

The work tree the command was run inside.

Source

pub fn trunk(&self) -> &Trunk

The trunk, as discovered.

Source

pub fn repository_name(&self) -> String

The primary checkout’s directory name: what the container is named after.

Source

pub fn registered_worktrees(&self) -> &[WorktreeRecord]

Every work tree git has registered, primary first, exactly as the porcelain listed them.

Source

pub fn is_primary(&self, record: &WorktreeRecord) -> bool

Is this record the primary checkout?

Source

pub fn is_current(&self, record: &WorktreeRecord) -> bool

Is the command running inside this record’s work tree?

Source

pub fn current_record(&self) -> Option<&WorktreeRecord>

The record of the work tree the command runs in, when git lists it.

Source

pub fn record_of_branch(&self, branch: &str) -> Option<&WorktreeRecord>

The record holding a branch, when one does.

Source

pub fn record_at(&self, path: &ResolvedPath) -> Option<&WorktreeRecord>

The record registered at a path, whatever the path is called.

Trait Implementations§

Source§

impl Clone for RepositoryIdentity

Source§

fn clone(&self) -> RepositoryIdentity

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RepositoryIdentity

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more