Struct CancelFlag 

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

Cheap cooperative cancel handle for long-running I/O.

None means never cancel (the common default). Some borrows an AtomicCancel owned by the CLI interrupt handler, UI, or embedder.

This is intentionally non-generic: every transfer path already needs a single type-erased shape for service structs (FetchServices, etc.).

Implementations

impl CancelFlag<'static>

pub const fn never() -> Self

A flag that never reports cancellation.

impl<'a> CancelFlag<'a>

pub const fn new(source: &'a AtomicCancel) -> Self

Wrap a shared atomic cancel source.

pub const fn never_dyn() -> CancelFlag<'static>

Alias for CancelFlag::never used by older call sites.

pub fn is_cancelled(self) -> bool

Whether cancellation has been requested.

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

Return GitError::Cancelled when the flag is set; otherwise Ok(()).

pub fn control(self) -> StreamControl

Map the flag into a StreamControl value for emit-style loops.

pub fn as_ref(self) -> CancelFlag<'a>

Borrowed view with a possibly shorter lifetime (no-op for Copy).

pub fn source(self) -> Option<&'a AtomicCancel>

Underlying atomic, if any.

Trait Implementations

impl<'a> Clone for CancelFlag<'a>

fn clone(&self) -> CancelFlag<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CancelFlag<'a>

impl<'a> Debug for CancelFlag<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CancelFlag<'a>

fn default() -> CancelFlag<'a>

Returns the “default value” for a type.