Struct ReadCheckout 

pub struct ReadCheckout<'a> { /* private fields */ }

A throwaway checkout of HEAD for calls that are only allowed to read.

The shared checkout is where a person, their editor, and any other agent work, and a read-only call is judged on what changed while it ran. Run there, an edit somebody else made in those minutes counted as the call’s: a draft that had only ever read was thrown away because another agent bumped a dependency beside it. Nothing works in this checkout but the calls spar starts in it, so whatever changes in it is theirs.

It holds what HEAD commits, after [loop] setup, and nothing uncommitted. Dropping it removes it, unless something in it changed that a read-only call was not allowed to change, in which case it is kept for recovery.

Implementations

impl ReadCheckout<'_>

pub fn path(&self) -> &Path

Trait Implementations

impl Drop for ReadCheckout<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.