alloy_rpc_client

Struct RpcCall

source
pub struct RpcCall<Conn, Params, Resp, Output = Resp, Map = fn(_: Resp) -> Output>
where Conn: Transport + Clone, Params: RpcParam, Map: FnOnce(Resp) -> Output,
{ /* private fields */ }
Expand description

A prepared, but unsent, RPC call.

This is a future that will send the request when polled. It contains a Request, a Transport, and knowledge of its expected response type. Upon awaiting, it will send the request and wait for the response. It will then deserialize the response into the expected type.

Errors are captured in the RpcResult type. Rpc Calls will result in either a successful response of the Resp type, an error response, or a transport error.

§Note

Serializing the request is done lazily. The request is not serialized until the future is polled. This differs from the behavior of crate::BatchRequest, which serializes greedily. This is because the batch request must immediately erase the Param type to allow batching of requests with different Param types, while the RpcCall may do so lazily.

Implementations§

source§

impl<Conn, Params, Resp, Output, Map> RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam, Map: FnOnce(Resp) -> Output,

source

pub fn map_resp<NewOutput, NewMap>( self, map: NewMap, ) -> RpcCall<Conn, Params, Resp, NewOutput, NewMap>
where NewMap: FnOnce(Resp) -> NewOutput,

Map the response to a different type. This is usable for converting the response to a more usable type, e.g. changing U64 to u64.

§Note

Carefully review the rust documentation on fn pointers before passing them to this function. Unless the pointer is specifically coerced to a fn(_) -> _, the NewMap will be inferred as that function’s unique type. This can lead to confusing error messages.

source

pub fn is_subscription(&self) -> bool

Returns true if the request is a subscription.

§Panics

Panics if called after the request has been sent.

source

pub fn set_is_subscription(&mut self)

Set the request to be a non-standard subscription (i.e. not “eth_subscribe”).

§Panics

Panics if called after the request has been sent.

source

pub fn set_subscription_status(&mut self, status: bool)

Set the subscription status of the request.

source

pub fn params(&mut self) -> &mut Params

Get a mutable reference to the params of the request.

This is useful for modifying the params after the request has been prepared.

§Panics

Panics if called after the request has been sent.

source

pub fn request(&self) -> &Request<Params>

Returns a reference to the request.

§Panics

Panics if called after the request has been sent.

source

pub fn request_mut(&mut self) -> &mut Request<Params>

Returns a mutable reference to the request.

§Panics

Panics if called after the request has been sent.

source

pub fn map_params<NewParams: RpcParam>( self, map: impl Fn(Params) -> NewParams, ) -> RpcCall<Conn, NewParams, Resp, Output, Map>

Map the params of the request into a new type.

source§

impl<Conn, Params, Resp, Output, Map> RpcCall<Conn, &Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam + ToOwned, Params::Owned: RpcParam, Map: FnOnce(Resp) -> Output,

source

pub fn into_owned_params( self, ) -> RpcCall<Conn, Params::Owned, Resp, Output, Map>

Convert this call into one with owned params, by cloning the params.

§Panics

Panics if called after the request has been polled.

source§

impl<'a, Conn, Params, Resp, Output, Map> RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam + 'a, Resp: RpcReturn, Output: 'static, Map: FnOnce(Resp) -> Output + Send + 'a,

source

pub fn boxed(self) -> RpcFut<'a, Output>

Convert this future into a boxed, pinned future, erasing its type.

Trait Implementations§

source§

impl<Conn, Params, Resp: Clone, Output: Clone, Map> Clone for RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone + Clone, Params: RpcParam + Clone, Map: FnOnce(Resp) -> Output + Clone,

source§

fn clone(&self) -> RpcCall<Conn, Params, Resp, Output, Map>

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<Conn, Params, Resp, Output, Map> Debug for RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam, Map: FnOnce(Resp) -> Output,

source§

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

Formats the value using the given formatter. Read more
source§

impl<Conn, Params, Resp, Output, Map> Future for RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam, Resp: RpcReturn, Output: 'static, Map: FnOnce(Resp) -> Output,

source§

type Output = Result<Output, RpcError<TransportErrorKind>>

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
source§

impl<'pin, Conn, Params, Resp, Output, Map> Unpin for RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Transport + Clone, Params: RpcParam, Map: FnOnce(Resp) -> Output, __RpcCall<'pin, Conn, Params, Resp, Output, Map>: Unpin,

Auto Trait Implementations§

§

impl<Conn, Params, Resp, Output, Map> Freeze for RpcCall<Conn, Params, Resp, Output, Map>
where Conn: Freeze, Map: Freeze, Params: Freeze,

§

impl<Conn, Params, Resp, Output = Resp, Map = fn(_: Resp) -> Output> !RefUnwindSafe for RpcCall<Conn, Params, Resp, Output, Map>

§

impl<Conn, Params, Resp, Output, Map> Send for RpcCall<Conn, Params, Resp, Output, Map>
where Map: Send,

§

impl<Conn, Params, Resp, Output = Resp, Map = fn(_: Resp) -> Output> !Sync for RpcCall<Conn, Params, Resp, Output, Map>

§

impl<Conn, Params, Resp, Output = Resp, Map = fn(_: Resp) -> Output> !UnwindSafe for RpcCall<Conn, Params, Resp, Output, Map>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T
where 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<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
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<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
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,

Available on crate feature std only.
Catches unwinding panics while polling the future. Read more
source§

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

Available on crate feature std only.
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,

Available on crate features channel and std only.
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>>
where Self: Sized + Send + 'a,

Available on crate feature alloc only.
Wrap the future in a Box, pinning it. Read more
source§

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

Available on crate feature alloc only.
Wrap the future in a Box, pinning it. Read more
source§

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

source§

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

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<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<U> for T
where U: From<T>,

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 F
where F: Future,

source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
source§

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 for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

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> TryClone for T
where T: Clone,

source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
source§

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

source§

type Error = Infallible

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

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

Performs the conversion.
source§

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

source§

type Ok = T

The type of successful values yielded by this future
source§

type Error = E

The type of failures yielded by this future
source§

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
source§

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

source§

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

Available on crate feature sink only.
Flattens the execution of this future when the successful result of this future is a Sink. Read more
source§

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
source§

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
source§

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
source§

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
source§

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.
source§

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
source§

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
source§

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
source§

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
source§

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
source§

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
source§

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
source§

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

Wraps a TryFuture into a type that implements Future. Read more
source§

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.
source§

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

source§

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

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

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

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where 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