Struct async_ops::Async[][src]

pub struct Async<Fut: Future> { /* fields omitted */ }
Expand description

A wrapper class for a Future that enables usage of some std::ops traits.

This struct will implement a supported std::ops trait when <Fut as Future>::Output type implements the same std::ops trait.

Implementations

Wraps the inner Future in Async with the given Assignable type so that it can be used with Assign variants of std::ops traits.

See also async_ops::assignable.

Example
use futures::executor::block_on;
use futures::future::LocalBoxFuture;

let a = async { 40 };
let b = async { 2 };

let result = async {
  let mut a = async_ops::on(a).assignable::<LocalBoxFuture<usize>>();
  a += b;
  a.await
};

assert_eq!(42, block_on(result));

Does the given Unary operation Op on the wrapped Future in Async and returns the result in a new Async.

Example
use std::future::{ready, Ready};
use futures::executor::block_on;
use async_ops::Unary;

struct Return42;

impl<Operand> Unary<Operand> for Return42 {
  type Output = Ready<usize>;
  fn op(_: Operand) -> Self::Output {
    ready(42)
  }
}

let a = async { 2 };

let result = async {
  async_ops::on(a).unary_op(Return42).await
};

assert_eq!(42, block_on(result));

Does the given Binary operation Op on the wrapped Future in Async and the given right-hand operand and returns the result in a new Async.

See also Async::op_assign.

Example
use futures::executor::block_on;
use async_ops::Binary;

struct ReturnRhs;

impl<Lhs, Rhs> Binary<Lhs, Rhs> for ReturnRhs {
  type Output = Rhs;
  fn op(_: Lhs, rhs: Rhs) -> Self::Output {
    rhs
  }
}

let a = async { 2 };
let b = async { 42 };

let result = async {
  async_ops::on(a).op(ReturnRhs, b).await
};

assert_eq!(42, block_on(result));

Does the given Binary operation Op on the wrapped Future in Async and the given right-hand operand and assigns it to self.

See also Async::op.

Example
use futures::executor::block_on;
use async_ops::Binary;

struct ReturnRhs;

impl<Lhs, Rhs> Binary<Lhs, Rhs> for ReturnRhs {
  type Output = Rhs;
  fn op(_: Lhs, rhs: Rhs) -> Self::Output {
    rhs
  }
}

let a = async { 2 };
let b = async { 42 };

let result = async {
  let mut a = async_ops::assignable(a);
  a.op_assign(ReturnRhs, b);
  a.await
};

assert_eq!(42, block_on(result));

Trait Implementations

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

The resulting type after applying the & operator.

Performs the & operation. Read more

Performs the &= operation. Read more

The resulting type after applying the | operator.

Performs the | operation. Read more

Performs the |= operation. Read more

The resulting type after applying the ^ operator.

Performs the ^ operation. Read more

Performs the ^= operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

Performs the /= operation. Read more

The type of value produced on completion.

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

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

Performs the %= operation. Read more

The resulting type after applying the << operator.

Performs the << operation. Read more

Performs the <<= operation. Read more

The resulting type after applying the >> operator.

Performs the >> operation. Read more

Performs the >>= operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Map this future’s output to a different type, returning a new future of the resulting type. Read more

Map this future’s output to a different type, returning a new future of the resulting type. Read more

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

Convert this future into a single element stream. Read more

Flatten the execution of this future when the output of this future is itself another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

Do something with the output of a future before passing it on. Read more

Catches unwinding panics while polling the future. Read more

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

Wrap the future in a Box, pinning it. Read more

Wrap the future in a Box, pinning it. Read more

A convenience for calling Future::poll on Unpin future types.

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

Performs the conversion.

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

The type returned in the event of a conversion error.

Performs the conversion.

The type of successful values yielded by this future

The type of failures yielded by this future

Poll this TryFuture as if it were a Future. Read more

Flattens the execution of this future when the successful result of this future is a [Sink]. Read more

Maps this future’s success value to a different value. Read more

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

Maps this future’s error value to a different value. Read more

Maps this future’s Error to a new error type using the Into trait. Read more

Maps this future’s Ok to a new type using the Into trait. Read more

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

Do something with the success value of a future before passing it on. Read more

Do something with the error value of a future before passing it on. Read more

Flatten the execution of this future when the successful result of this future is another future. Read more

Flatten the execution of this future when the successful result of this future is a stream. Read more

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

Wraps a [TryFuture] into a type that implements Future. Read more

A convenience method for calling [TryFuture::try_poll] on Unpin future types. Read more

The type returned in the event of a conversion error.

Performs the conversion.