Struct tantivy::FutureResult

pub struct FutureResult<T> { /* private fields */ }

FutureResult is a handle that makes it possible to wait for the completion of an ongoing task.

Contrary to some Future, it does not need to be polled for the task to progress. Dropping the FutureResult does not cancel the task being executed either.

• In a sync context, you can call FutureResult::wait(). The function does not rely on block_on.
• In an async context, you can call simply use FutureResult as a future.

Implementations

impl<T> FutureResult<T>

pub fn wait(self) -> Result<T>

Blocks until the scheduled result is available.

In an async context, you should simply use ScheduledResult as a future.

Trait Implementations

impl<T> From<TantivyError> for FutureResult<T>

fn from(err: TantivyError) -> Self

Converts to this type from the input type.

impl<T> Future for FutureResult<T>

type Output = Result<T, TantivyError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.