Skip to main content

CandidateRequest

Enum CandidateRequest 

Source
pub enum CandidateRequest {
    Add(Vec<OsString>),
    Direct(Vec<OsString>),
    Staged(Vec<OsString>),
    StagedAtBase {
        base: Option<ObjectId>,
        pathspecs: Vec<OsString>,
    },
    Pushed(PushedScope),
    Landed(ObjectId),
}
Expand description

What: What a lifecycle asks for. An enum is a closed set of named alternatives; each carries the arguments it needs. #[derive(...)] generates cloning, debug printing and ==. Why: The two sources differ only in what is staged on the private copy and in which entries become candidates.

In TS you’d write (pseudocode):

type CandidateRequest = { kind: 'add'; region: string[] } | { kind: 'direct'; pathspecs: string[] };

Variants§

§

Add(Vec<OsString>)

What git add with these arguments would stage.

Tuple Fields

§0: Vec<OsString>

The arguments after add, wrapper controls removed.

§

Direct(Vec<OsString>)

The worktree files a direct command selects.

Tuple Fields

§0: Vec<OsString>

The pathspecs of the scope; --all is :/.

§

Staged(Vec<OsString>)

The entries the index already holds for the pathspecs, read without staging the worktree first. The commit path uses it, so corrections already written to the private index are the candidates.

Tuple Fields

§0: Vec<OsString>

The pathspecs of the scope.

§

StagedAtBase

The entries the private index holds for the pathspecs, with a recorded base commit (the empty tree when the branch was unborn) as the baseline that marks additions, read without staging the worktree. The commit transaction uses it: its baseline is the base it recorded at invocation, never the HEAD another landing may have moved since. No pathspec means no candidate.

Fields

§base: Option<ObjectId>

The recorded base commit, or nothing for an unborn branch.

§pathspecs: Vec<OsString>

The pathspecs of the scope, each literal and rooted at the top level.

§

Pushed(PushedScope)

The changes a manual push publishes: each newly published commit’s own delta and the whole tree of each tip with no known published base.

Tuple Fields

§0: PushedScope

The commits and trees the scan reads.

§

Landed(ObjectId)

The paths one landed commit changed, each against every parent, as the post-commit gate reads them: the committed bytes and no worktree or index state.

Tuple Fields

§0: ObjectId

The landed commit whose tree changes are listed.

Trait Implementations§

Source§

impl Clone for CandidateRequest

Source§

fn clone(&self) -> Self

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 CandidateRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CandidateRequest

Source§

impl PartialEq for CandidateRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CandidateRequest

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
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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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