Struct jsonrpsee_ws_server::WsServerHandle

source ·

pub struct WsServerHandle(_);

Expand description

Handle that is able to stop the running server or wait for it to finish its execution.

Implementations§

source §

impl ServerHandle

source

pub fn stop(self) -> Result<ShutdownWaiter, Error>

Requests server to stop. Returns an error if server was already stopped.

Returns a future that can be awaited for when the server shuts down.

Trait Implementations§

source §

impl Clone for ServerHandle

source §

fn clone(&self) -> ServerHandle ⓘ

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source §

impl Debug for ServerHandle

source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source §

impl Future for ServerHandle

§

type Output = ()

The type of value produced on completion.

source §

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. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for ServerHandle

Blanket Implementations§

source §

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

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

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

Mutably borrows from an owned value. Read more

source §

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source §

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

source §

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

source §

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

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

source §

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

source §

fn left_future(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

source §

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

source §

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

Convert this future into a single element stream. Read more

source §

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

source §

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

source §

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

source §

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

source §

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

Catches unwinding panics while polling the future. Read more

source §

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

source §

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

source §

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

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

source §

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

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

source §

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

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

source §

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

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

source §

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

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

source §

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

source §

impl<F> FutureExt for Fwhere
F: Future + ?Sized,

source §

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

A convenience for calling Future::poll() on !Unpin types.

source §

fn or<F>(self, other: F) -> Or<Self, F>where
Self: Sized,
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

source §

fn race<F>(self, other: F) -> Race<Self, F>where
Self: Sized,
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

source §

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

Catches panics while polling the future. Read more

source §

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

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

source §

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

Boxes the future and changes its type to dyn Future + 'a. Read more

source §

impl<T> Instrument for T

source §

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

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

source §

impl<T> Instrument for T

source §

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

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

source §

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source§

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<F> IntoFuture for Fwhere
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?

source §

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

Creates a future from a value. Read more

source §

impl<T> Same<T> for T

§

type Output = T

Should always be Self

source §

impl<T> ToOwned for Twhere
T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.

source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source §

impl<T, U> TryFrom for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

source §

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source §

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

source §

fn vzip(self) -> V

source §

impl<T> WithSubscriber for T

source §

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

source §

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source §

impl<T> WithSubscriber for T

source §

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

source §

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source §

Struct jsonrpsee_ws_server::WsServerHandle

Implementations§

impl ServerHandle

pub fn stop(self) -> Result<ShutdownWaiter, Error>

Trait Implementations§

impl Clone for ServerHandle

fn clone(&self) -> ServerHandle ⓘ

fn clone_from(&mut self, source: &Self)

impl Debug for ServerHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Future for ServerHandle

type Output = ()

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

Auto Trait Implementations§

impl !RefUnwindSafe for ServerHandle

impl Send for ServerHandle

impl Sync for ServerHandle

impl Unpin for ServerHandle

impl !UnwindSafe for ServerHandle

Blanket Implementations§

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

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

impl<T> From<T> for T

fn from(t: T) -> T

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<F> FutureExt for Fwhere F: Future + ?Sized,

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

fn or<F>(self, other: F) -> Or<Self, F>where Self: Sized, F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F>where Self: Sized, F: Future<Output = Self::Output>,

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

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

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

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

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

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

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

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<F> FutureExt for Fwhere
F: Future + ?Sized,

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

fn or<F>(self, other: F) -> Or<Self, F>where
Self: Sized,
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F>where
Self: Sized,
F: Future<Output = Self::Output>,

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

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

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

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<F> IntoFuture for Fwhere
F: Future,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

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

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

impl<T> MaybeSend for Twhere
T: Send,