# ProverFuture in tlsn::prover - Rust
Prover future which must be polled for the TLS connection to make progress.

Skip to main content

## ProverFuture

# Struct ProverFuture

Source

    pub struct ProverFuture<S> { /* private fields */ }

Expand description

Prover future which must be polled for the TLS connection to make progress.

## Implementations§

Source §

### impl<S> ProverFuture<S>

Source

#### pub fn control(&self) -> ProverControl

Returns a controller for the prover for advanced functionality.

## Trait Implementations§

Source §

### impl<S> FusedFuture for ProverFuture<S>
where S: AsyncRead + AsyncWrite + Send + Unpin + 'static,

Source §

#### fn is_terminated(&self) -> bool

Returns `true` if the underlying future should no longer be polled.
Source §

### impl<S> Future for ProverFuture<S>
where S: AsyncRead + AsyncWrite + Send + Unpin + 'static,

Source §

#### type Output = Result<Prover<Committed>, Error>

The type of value produced on completion.
Source §

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

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

## Auto Trait Implementations§

§

### impl<S> Freeze for ProverFuture<S>
where S: Freeze,

§

### impl<S> !RefUnwindSafe for ProverFuture<S>

§

### impl<S> Send for ProverFuture<S>
where S: Send,

§

### impl<S> !Sync for ProverFuture<S>

§

### impl<S> Unpin for ProverFuture<S>
where S: Unpin,

§

### impl<S> UnsafeUnpin for ProverFuture<S>
where S: UnsafeUnpin,

§

### impl<S> !UnwindSafe for ProverFuture<S>

## Blanket Implementations§

§

### impl<T> Any for T
where T: 'static + ?Sized,

§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T> Borrow<T> for T
where T: ?Sized,

§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<T> Conv for T

§

#### fn conv<T>(self) -> T
where Self: Into<T>,

Converts `self` into `T` using `Into<T>`. Read more
§

### impl<T> FmtForward for T

§

#### fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes `self` to use its `Binary` implementation when `Debug`-formatted.
§

#### fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes `self` to use its `Display` implementation when `Debug`-formatted.
§

#### fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes `self` to use its `LowerExp` implementation when `Debug`-formatted.
§

#### fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes `self` to use its `LowerHex` implementation when `Debug`-formatted.
§

#### fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes `self` to use its `Octal` implementation when `Debug`-formatted.
§

#### fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes `self` to use its `Pointer` implementation when `Debug`-formatted.
§

#### fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes `self` to use its `UpperExp` implementation when `Debug`-formatted.
§

#### fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes `self` to use its `UpperHex` implementation when `Debug`-formatted.
§

#### fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

### impl<T> From<T> for T

§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<F> FutureExt for F
where F: Future,

§

#### fn block_on(self) -> Self::Output
where Self: Sized,

Block the thread until the future is ready. Read more
§

### impl<T> FutureExt for T
where T: Future + ?Sized,

§

#### fn map<U, F>(self, f: F) -> Map<Self, F>
where F: FnOnce(Self::Output) -> U, Self: Sized,

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

#### fn map_into<U>(self) -> MapInto<Self, U>
where Self::Output: Into<U>, Self: Sized,

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

#### fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>
where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,

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

#### fn left_future<B>(self) -> Either<Self, B>
where B: Future<Output = Self::Output>, Self: Sized,

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

#### fn right_future<A>(self) -> Either<A, Self>
where A: Future<Output = Self::Output>, Self: Sized,

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

#### fn into_stream(self) -> IntoStream<Self>
where Self: Sized,

Convert this future into a single element stream. Read more
§

#### fn flatten(self) -> Flatten<Self>
where Self::Output: Future, Self: Sized,

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

#### fn flatten_stream(self) -> FlattenStream<Self>
where Self::Output: Stream, Self: Sized,

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

#### fn fuse(self) -> Fuse<Self>
where Self: Sized,

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
§

#### fn inspect<F>(self, f: F) -> Inspect<Self, F>
where F: FnOnce(&Self::Output), Self: Sized,

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

#### fn catch_unwind(self) -> CatchUnwind<Self>
where Self: Sized + UnwindSafe,

Catches unwinding panics while polling the future. Read more
§

#### fn shared(self) -> Shared<Self>
where Self: Sized, Self::Output: Clone,

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

#### fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
where Self: Sized,

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

#### fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>
where Self: Sized + Send + 'a,

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

#### fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>>
where Self: Sized + 'a,

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

#### fn unit_error(self) -> UnitError<Self>
where Self: Sized,

Turns a `Future<Output = T>` into a `TryFuture<Ok = T, Error = ()`>.
§

#### fn never_error(self) -> NeverError<Self>
where Self: Sized,

Turns a `Future<Output = T>` into a `TryFuture<Ok = T, Error = Never`>.
§

#### fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>
where Self: Unpin,

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

#### fn now_or_never(self) -> Option<Self::Output>
where Self: Sized,

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

### impl<T> FutureExt for T
where T: Future + ?Sized,

§

#### fn with_cancellation_token( self, cancellation_token: &CancellationToken, ) -> WithCancellationTokenFuture<'_, Self>
where Self: Sized,

Similar to [`CancellationToken::run_until_cancelled`], but with the advantage that it is easier to write fluent call chains. Read more
§

#### fn with_cancellation_token_owned( self, cancellation_token: CancellationToken, ) -> WithCancellationTokenFutureOwned<Self>
where Self: Sized,

Similar to [`CancellationToken::run_until_cancelled_owned`], but with the advantage that it is easier to write fluent call chains. Read more
§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
§

### impl<T, U> Into<U> for T
where U: From<T>,

§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `[From]<T> for U` chooses to do.

Source §

### impl<T> IntoEither for T

Source §

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source §

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<F> IntoFuture for F
where F: Future,

§

#### type Output = <F as Future>::Output

The output that the future will produce on completion.
§

#### type IntoFuture = F

Which kind of future are we turning this into?
§

#### fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
§

### impl<T> Pipe for T
where T: ?Sized,

§

#### fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

#### fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows `self` and passes that borrow into the pipe function. Read more
§

#### fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows `self` and passes that borrow into the pipe function. Read more
§

#### fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows `self`, then passes `self.borrow()` into the pipe function. Read more
§

#### fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows `self`, then passes `self.borrow_mut()` into the pipe function. Read more
§

#### fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows `self`, then passes `self.as_ref()` into the pipe function.
§

#### fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows `self`, then passes `self.as_mut()` into the pipe function.
§

#### fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows `self`, then passes `self.deref()` into the pipe function.
§

#### fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows `self`, then passes `self.deref_mut()` into the pipe function.
§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source §

### impl<T> Same for T

Source §

#### type Output = T

Should always be `Self`
§

### impl<T> Tap for T

§

#### fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

#### fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

#### fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the `Borrow<B>` of a value. Read more
§

#### fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the `BorrowMut<B>` of a value. Read more
§

#### fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the `AsRef<R>` view of a value. Read more
§

#### fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the `AsMut<R>` view of a value. Read more
§

#### fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the `Deref::Target` of a value. Read more
§

#### fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the `Deref::Target` of a value. Read more
§

#### fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls `.tap()` only in debug builds, and is erased in release builds.
§

#### fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls `.tap_mut()` only in debug builds, and is erased in release builds.
§

#### fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls `.tap_borrow()` only in debug builds, and is erased in release builds.
§

#### fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls `.tap_borrow_mut()` only in debug builds, and is erased in release builds.
§

#### fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls `.tap_ref()` only in debug builds, and is erased in release builds.
§

#### fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls `.tap_ref_mut()` only in debug builds, and is erased in release builds.
§

#### fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls `.tap_deref()` only in debug builds, and is erased in release builds.
§

#### fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls `.tap_deref_mut()` only in debug builds, and is erased in release builds.
§

### impl<T> TryConv for T

§

#### fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert `self` into `T` using `TryInto<T>`. Read more
§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

### impl<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

§

#### type Ok = T

The type of successful values yielded by this future
§

#### type Error = E

The type of failures yielded by this future
§

#### fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

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

### impl<Fut> TryFutureExt for Fut
where Fut: TryFuture + ?Sized,

§

#### fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok>
where Self::Ok: Sink<Item, Error = Self::Error>, Self: Sized,

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

#### fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>
where F: FnOnce(Self::Ok) -> T, Self: Sized,

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

#### fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E>
where F: FnOnce(Self::Ok) -> T, E: FnOnce(Self::Error) -> T, Self: Sized,

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

#### fn map_err<E, F>(self, f: F) -> MapErr<Self, F>
where F: FnOnce(Self::Error) -> E, Self: Sized,

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

#### fn err_into<E>(self) -> ErrInto<Self, E>
where Self: Sized, Self::Error: Into<E>,

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

#### fn ok_into<U>(self) -> OkInto<Self, U>
where Self: Sized, Self::Ok: Into<U>,

Maps this future’s `Ok` to a new type using the `Into` trait.
§

#### fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>
where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>, Self: Sized,

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

#### fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>
where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>, Self: Sized,

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
§

#### fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>
where F: FnOnce(&Self::Ok), Self: Sized,

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

#### fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>
where F: FnOnce(&Self::Error), Self: Sized,

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

#### fn try_flatten(self) -> TryFlatten<Self, Self::Ok>
where Self::Ok: TryFuture<Error = Self::Error>, Self: Sized,

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

#### fn try_flatten_stream(self) -> TryFlattenStream<Self>
where Self::Ok: TryStream<Error = Self::Error>, Self: Sized,

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

#### fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> Self::Ok,

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

#### fn into_future(self) -> IntoFuture<Self>
where Self: Sized,

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

#### fn try_poll_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Self::Ok, Self::Error>>
where Self: Unpin,

A convenience method for calling [`TryFuture::try_poll`] on [`Unpin`] future types.
§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source §

### impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source §

#### fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source §

#### fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more