Struct jsonrpc_client_transports::transports::local::LocalRpc

[+] Show declaration

pub struct LocalRpc<THandler, TMetadata> { /* fields omitted */ }

[−] Expand description

Implements a rpc client for MetaIoHandler.

Implementations

impl<TMetadata, THandler, TMiddleware> LocalRpc<THandler, TMetadata> where
    TMetadata: Metadata,
    TMiddleware: Middleware<TMetadata>,
    THandler: Deref<Target = MetaIoHandler<TMetadata, TMiddleware>>, [−]

pub fn new(handler: THandler) -> Self where
    TMetadata: Default, [−]

Creates a new LocalRpc with default metadata.

pub fn with_metadata(handler: THandler, meta: TMetadata) -> Self[−]

Creates a new LocalRpc with given handler and metadata.

Trait Implementations

impl<TMetadata, THandler, TMiddleware> Sink for LocalRpc<THandler, TMetadata> where
    TMetadata: Metadata,
    TMiddleware: Middleware<TMetadata>,
    THandler: Deref<Target = MetaIoHandler<TMetadata, TMiddleware>>, [+]

[+] Show hidden undocumented items

type SinkItem = String

The type of value that the sink accepts.

type SinkError = RpcError

The type of value produced by the sink when an error occurs.

fn start_send(
    &mut self,
    request: Self::SinkItem
) -> Result<AsyncSink<Self::SinkItem>, Self::SinkError>[−]

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Result<Async<()>, Self::SinkError>[−]

Flush all output from this sink, if necessary.

pub fn close(&mut self) -> Result<Async<()>, Self::SinkError>[−]

A method to indicate that no more values will ever be pushed into this sink.

pub fn wait(self) -> Wait<Self>[−]

Creates a new object which will produce a synchronous sink.

pub fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>, [−]

Composes a function in front of the sink.

pub fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, [−]

Composes a function in front of the sink.

pub fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, [−]

Transforms the error returned by the sink.

pub fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
    E: From<Self::SinkError>, [−]

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink.

pub fn buffer(self, amt: usize) -> Buffer<Self>[−]

Adds a fixed-size buffer to the current sink.

pub fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, [−]

Fanout items to multiple sinks.

pub fn flush(self) -> Flush<Self>[−]

A future that completes when the sink has finished processing all pending requests.

pub fn send(self, item: Self::SinkItem) -> Send<Self>[−]

A future that completes after the given item has been fully processed into the sink, including flushing.

pub fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>, [−]

A future that completes after the given stream has been fully processed into the sink, including flushing.

impl<TMetadata, THandler, TMiddleware> Stream for LocalRpc<THandler, TMetadata> where
    TMetadata: Metadata,
    TMiddleware: Middleware<TMetadata>,
    THandler: Deref<Target = MetaIoHandler<TMetadata, TMiddleware>>, [+]

[+] Show hidden undocumented items

type Item = String

The type of item this stream will yield on success.

type Error = RpcError

The type of error this stream may generate.

fn poll(&mut self) -> Result<Async<Option<Self::Item>>, Self::Error>[−]

Attempt to pull out the next value of this stream, returning None if the stream is finished.

pub fn wait(self) -> Wait<Self>[−]

Creates an iterator which blocks the current thread until each item of this stream is resolved.

pub fn into_future(self) -> StreamFuture<Self>[−]

Converts this stream into a Future.

pub fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, [−]

Converts a stream of type T to a stream of type U.

pub fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, [−]

Converts a stream of error type T to a stream of error type U.

pub fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, [−]

Filters the values produced by this stream according to the provided predicate.

pub fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, [−]

Filters the values produced by this stream while simultaneously mapping them to a different type.

pub fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    U: IntoFuture,
    F: FnMut(Result<Self::Item, Self::Error>) -> U, [−]

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

pub fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    U: IntoFuture<Error = Self::Error>,
    F: FnMut(Self::Item) -> U, [−]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

pub fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    U: IntoFuture<Item = Self::Item>,
    F: FnMut(Self::Error) -> U, [−]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

pub fn collect(self) -> Collect<Self>[−]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

pub fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, [−]

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

pub fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, [−]

👎 Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

pub fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, [−]

Execute an accumulating computation over a stream, collecting all the values into one final result.

pub fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, [−]

Flattens a stream of streams into just one continuous stream.

pub fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    R: IntoFuture<Item = bool, Error = Self::Error>,
    P: FnMut(&Self::Item) -> R, [−]

Skip elements on this stream while the predicate provided resolves to true.

pub fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    R: IntoFuture<Item = bool, Error = Self::Error>,
    P: FnMut(&Self::Item) -> R, [−]

Take elements from this stream while the predicate provided resolves to true.

pub fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    U: IntoFuture<Item = (), Error = Self::Error>,
    F: FnMut(Self::Item) -> U, [−]

Runs this stream to completion, executing the provided closure for each element on the stream.

pub fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, [−]

Map this stream’s error to any error implementing From for this stream’s Error, returning a new stream.

pub fn take(self, amt: u64) -> Take<Self>[−]

Creates a new stream of at most amt items of the underlying stream.

pub fn skip(self, amt: u64) -> Skip<Self>[−]

Creates a new stream which skips amt items of the underlying stream.

pub fn fuse(self) -> Fuse<Self>[−]

Fuse a stream such that poll will never again be called once it has finished.

pub fn by_ref(&mut self) -> &mut Self[−]

Borrows a stream, rather than consuming it.

pub fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, [−]

Catches unwinding panics while polling the stream.

pub fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, [−]

An adaptor for creating a buffered list of pending futures.

pub fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, [−]

An adaptor for creating a buffered list of pending futures (unordered).

pub fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, [−]

👎 Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

pub fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, [−]

An adapter for zipping two streams together.

pub fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, [−]

Adapter for chaining two stream.

pub fn peekable(self) -> Peekable<Self>[−]

Creates a new stream which exposes a peek method.

pub fn chunks(self, capacity: usize) -> Chunks<Self>[−]

An adaptor for chunking up items of the stream inside a vector.

pub fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, [−]

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

pub fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, [−]

A future that completes after the given stream has been fully processed into the sink, including flushing.

pub fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, [−]

Splits this Stream + Sink object into separate Stream and Sink objects.

pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), [−]

Do something with each item of this stream, afterwards passing it on.

pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), [−]

Do something with the error of this stream, afterwards passing it on.