#include "tensorstore/util/future.h"
class [[nodiscard]] tensorstore::AnyFuture;

Generic consumer interface to a one-time channel.

Constructors

explicit AnyFuture();

Constructs an null AnyFuture. :post: null().

Methods

void IgnoreFuture() const;

Ignores the future. This method signals intent to ignore the result to suppress compiler warnings from [[nodiscard]].

void reset();

Resets this Future to be null.

bool null() const;

Returns true if this Future has no shared state.

bool ready() const;

Returns true if the result is ready.

void Wait() const;

Calls Force(), and waits until ready() == true.

bool WaitFor(absl::Duration duration) const;

Waits for up to the specified duration for the result to be ready.

bool WaitUntil(absl::Time deadline) const;

Waits until the specified time for the result to be ready.

void Force() const;

Calls any Force callbacks registered on the associated Promise, if they have not already been called.

const absl::Status& status() const&;

Calls Force(), waits for the result to be ready, and returns a const reference to the contained absl::Status. If the underlying Future contains a value, then this function returns absl::OkStatus().

FutureCallbackRegistration
UntypedExecuteWhenReady(Callback&& callback);

Executes callback with the signature void(AnyFuture) when this becomes ready.

bool tensorstore::HaveSameSharedState(const AnyFuture& a,
                                      const AnyFuture& b);

Returns true if both futures refer to the same shared state, or are both null.

absl::Status tensorstore::GetStatus(const AnyFuture& future);

Waits for the future to be ready and returns the status.