Skip to main content

FanoutWorktree

Struct FanoutWorktree 

Source
pub struct FanoutWorktree<'a> { /* private fields */ }
Expand description

An open fan-out scratch worktree. Hold txns through worktree_repo(); finalize via commit_fanout (merge back) or abandon_fanout (discard).

Implementations§

Source§

impl<'a> FanoutWorktree<'a>

Source

pub fn worktree_repo(&self) -> &VaultRepo

The substrate handle for changesets inside the fan-out.

Source

pub fn wip_branch(&self) -> &str

The wip branch the fan-out commits to (wip/<id>).

Source

pub fn parent_tip(&self) -> Oid

Main’s tip when the fan-out began.

Source

pub fn info(&self) -> &FanoutInfo

The full info handle (stateless; usable by merge_fanout_back / abandon_fanout_by_info when this FanoutWorktree’s borrow ends).

Source

pub fn commit_fanout(self, strategy: MergeStrategy) -> Result<MergeBackResult>

Merge the fan-out back into main and clean up the scratch worktree. On any error the fan-out artifacts may be left behind; call abandon_fanout to clean up explicitly.

Source

pub fn commit_fanout_with_message( self, strategy: MergeStrategy, message: Option<&str>, ) -> Result<MergeBackResult>

turbovault-b1q: like Self::commit_fanout but with a caller-supplied merge-commit subject (used by the MCP commit_transaction tool’s commit_message). None falls back to the auto-derived message.

Source

pub fn abandon_fanout(self) -> Result<()>

Discard the fan-out: nothing lands on main; scratch worktree + wip branch removed.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for FanoutWorktree<'a>

§

impl<'a> !Send for FanoutWorktree<'a>

§

impl<'a> !Sync for FanoutWorktree<'a>

§

impl<'a> !UnwindSafe for FanoutWorktree<'a>

§

impl<'a> Freeze for FanoutWorktree<'a>

§

impl<'a> Unpin for FanoutWorktree<'a>

§

impl<'a> UnsafeUnpin for FanoutWorktree<'a>

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> 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, 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.
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