bloqade.task.BatchFuture

← Module overview

classBatchFuture¶source

bloqade.task.BatchFuture

Bases: abc.ABC, Generic[RetType]

Protocol for future objects that can be awaited.

class BatchFuture

Public import paths

• from bloqade.device import BatchFuture

Attributes

Name	Type	Default	Description
MISSING_RESULT	—	Literal[None]

methodresult¶source

bloqade.task.BatchFuture.result

def result(timeout: float | None) -> list[RetType]

Returns the result of the future, blocking until it is available or the timeout expires.

Parameters

Name	Type	Description
timeout	float | None

Returns

list[RetType]

source

methodpartial_result¶source

bloqade.task.BatchFuture.partial_result

def partial_result() -> list[RetType | MISSING_RESULT]

Return all results that are available so far, or MISSING_RESULT for those that are not yet available.

Returns

list[RetType | MISSING_RESULT]

source

methodfetch¶source

bloqade.task.BatchFuture.fetch

def fetch() -> None

Fetches the result of the future that are currently available.

source

methodcancel¶source

bloqade.task.BatchFuture.cancel

def cancel()

Attempts to cancel the execution of the future.

source

methodcancelled¶source

bloqade.task.BatchFuture.cancelled

def cancelled() -> bool

Returns True if the future was cancelled, False otherwise.

Returns

bool

source

methoddone¶source

bloqade.task.BatchFuture.done

def done() -> bool

Returns

bool

source