Struct IndexRefreshHandle 

pub struct IndexRefreshHandle { /* private fields */ }

What: Represent one caller-supplied background official-index refresh.

Inputs:

• Created by spawn_index_refresh from a future that produces an OfficialIndex or a structured toolkit error.

Output:

• A handle that can cancel pending async work and explicitly await its result/error delivery.

Details:

• This handle owns no global index and performs no system mutation.
• Cancellation aborts the async task; cooperative futures such as caller HTTP requests are dropped promptly, while caller code still owns any external resource semantics.

Implementations

impl IndexRefreshHandle

pub fn cancel(&self)

What: Request cancellation of a pending background refresh.

Inputs: None.

Output:

• Requests task abortion; Self::wait reports a structured cancelled error if the task did not complete first.

Details:

• Cancellation is idempotent and does not block the calling thread.
• It is meaningful for async futures; callers should not wrap a non-cancellable spawn_blocking operation in this API and expect it to stop after it has started.

pub fn is_finished(&self) -> bool

What: Check whether the refresh task has completed.

Inputs: None.

Output:

• true after successful, failed, panicked, or cancelled completion.

Details:

• This is an observation only; use Self::wait for explicit result or error delivery.

pub async fn wait(self) -> Result<OfficialIndex>

What: Await the background refresh result and deliver task failures explicitly.

Inputs:

• self: Consumes the handle and awaits the owned task.

Output:

• Refreshed OfficialIndex or the refresh/task/cancellation error.

Details:

• A cancelled task maps to an actionable parse error instead of silently returning an empty index. Panics and runtime failures also remain visible to the caller.

Errors

Returns the caller future’s error or a descriptive task failure mapped to ArchToolkitError::Parse.

Trait Implementations

impl Debug for IndexRefreshHandle

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

Formats the value using the given formatter.