reth_rpc_builder

Struct TransportRpcModules

Help

pub struct TransportRpcModules<Context = ()> { /* private fields */ }

Expand description

Holds installed modules per transport type.

Implementations§

impl TransportRpcModules

pub fn with_config(self, config: TransportRpcModuleConfig) -> Self

Sets a custom TransportRpcModuleConfig for the configured modules. This will overwrite current configuration, if any.

pub fn with_http(self, http: RpcModule<()>) -> Self

Sets the [RpcModule] for the http transport. This will overwrite current module, if any.

pub fn with_ws(self, ws: RpcModule<()>) -> Self

Sets the [RpcModule] for the ws transport. This will overwrite current module, if any.

pub fn with_ipc(self, ipc: RpcModule<()>) -> Self

Sets the [RpcModule] for the http transport. This will overwrite current module, if any.

pub const fn module_config(&self) -> &TransportRpcModuleConfig

Returns the TransportRpcModuleConfig used to configure this instance.

pub fn merge_if_module_configured( &mut self, module: RethRpcModule, other: impl Into<Methods>, ) -> Result<(), RegisterMethodError>

Merge the given [Methods] in all configured transport modules if the given RethRpcModule is configured for the transport.

Fails if any of the methods in other is present already.

pub fn merge_http( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Merge the given [Methods] in the configured http methods.

Fails if any of the methods in other is present already.

Returns [Ok(false)] if no http transport is configured.

pub fn merge_ws( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Merge the given [Methods] in the configured ws methods.

Fails if any of the methods in other is present already.

Returns [Ok(false)] if no ws transport is configured.

pub fn merge_ipc( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Merge the given [Methods] in the configured ipc methods.

Fails if any of the methods in other is present already.

Returns [Ok(false)] if no ipc transport is configured.

pub fn merge_configured( &mut self, other: impl Into<Methods>, ) -> Result<(), RegisterMethodError>

Merge the given [Methods] in all configured methods.

Fails if any of the methods in other is present already.

pub fn methods_by_module<F>(&self, module: RethRpcModule) -> Methods

Returns all unique endpoints installed for the given module.

Note: In case of duplicate method names this only record the first occurrence.

pub fn methods_by<F>(&self, filter: F) -> Methods
where F: FnMut(&str) -> bool,

Returns all unique endpoints installed in any of the configured modules.

Note: In case of duplicate method names this only record the first occurrence.

pub fn http_methods<F>(&self, filter: F) -> Option<Methods>
where F: FnMut(&str) -> bool,

Returns all [Methods] installed for the http server based in the given closure.

Returns None if no http support is configured.

pub fn ws_methods<F>(&self, filter: F) -> Option<Methods>
where F: FnMut(&str) -> bool,

Returns all [Methods] installed for the ws server based in the given closure.

Returns None if no ws support is configured.

pub fn ipc_methods<F>(&self, filter: F) -> Option<Methods>
where F: FnMut(&str) -> bool,

Returns all [Methods] installed for the ipc server based in the given closure.

Returns None if no ipc support is configured.

pub fn remove_http_method(&mut self, method_name: &'static str) -> bool

Removes the method with the given name from the configured http methods.

Returns true if the method was found and removed, false otherwise.

Be aware that a subscription consist of two methods, subscribe and unsubscribe and it’s the caller responsibility to remove both subscribe and unsubscribe methods for subscriptions.

pub fn remove_http_methods( &mut self, methods: impl IntoIterator<Item = &'static str>, )

Removes the given methods from the configured http methods.

pub fn remove_ws_method(&mut self, method_name: &'static str) -> bool

Removes the method with the given name from the configured ws methods.

Returns true if the method was found and removed, false otherwise.

Be aware that a subscription consist of two methods, subscribe and unsubscribe and it’s the caller responsibility to remove both subscribe and unsubscribe methods for subscriptions.

pub fn remove_ws_methods( &mut self, methods: impl IntoIterator<Item = &'static str>, )

Removes the given methods from the configured ws methods.

pub fn remove_ipc_method(&mut self, method_name: &'static str) -> bool

Removes the method with the given name from the configured ipc methods.

Returns true if the method was found and removed, false otherwise.

Be aware that a subscription consist of two methods, subscribe and unsubscribe and it’s the caller responsibility to remove both subscribe and unsubscribe methods for subscriptions.

pub fn remove_ipc_methods( &mut self, methods: impl IntoIterator<Item = &'static str>, )

Removes the given methods from the configured ipc methods.

pub fn remove_method_from_configured( &mut self, method_name: &'static str, ) -> bool

Removes the method with the given name from all configured transports.

Returns true if the method was found and removed, false otherwise.

pub fn rename( &mut self, old_name: &'static str, new_method: impl Into<Methods>, ) -> Result<(), RegisterMethodError>

Renames a method in all configured transports by:

Removing the old method name.
Adding the new method.

pub fn replace_http( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Replace the given [Methods] in the configured http methods.

Fails if any of the methods in other is present already or if the method being removed is not present

Returns [Ok(false)] if no http transport is configured.

pub fn replace_ipc( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Replace the given [Methods] in the configured ipc methods.

Fails if any of the methods in other is present already or if the method being removed is not present

Returns [Ok(false)] if no ipc transport is configured.

pub fn replace_ws( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Replace the given [Methods] in the configured ws methods.

Fails if any of the methods in other is present already or if the method being removed is not present

Returns [Ok(false)] if no ws transport is configured.

pub fn replace_configured( &mut self, other: impl Into<Methods>, ) -> Result<bool, RegisterMethodError>

Replaces the method with the given name from all configured transports.

Returns true if the method was found and replaced, false otherwise

Trait Implementations§

impl<Context: Clone> Clone for TransportRpcModules<Context>

fn clone(&self) -> TransportRpcModules<Context>

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

impl<Context: Debug> Debug for TransportRpcModules<Context>

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

Formats the value using the given formatter. Read more

impl<Context: Default> Default for TransportRpcModules<Context>

fn default() -> TransportRpcModules<Context>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<Context> Freeze for TransportRpcModules<Context>

impl<Context = ()> !RefUnwindSafe for TransportRpcModules<Context>

impl<Context> Send for TransportRpcModules<Context>
where Context: Sync + Send,

impl<Context> Sync for TransportRpcModules<Context>
where Context: Sync + Send,

impl<Context> Unpin for TransportRpcModules<Context>

impl<Context = ()> !UnwindSafe for TransportRpcModules<Context>

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dest. 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> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

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<TxEnv, T> FromRecoveredTx<&T> for TxEnv
where TxEnv: FromRecoveredTx<T>,

fn from_recovered_tx(tx: &&T, sender: Address) -> TxEnv

Builds a TxEnv from a transaction and a sender address.

impl<TxEnv, T> FromTxWithEncoded<&T> for TxEnv
where TxEnv: FromTxWithEncoded<T>,

fn from_encoded_tx(tx: &&T, sender: Address, encoded: Bytes) -> TxEnv

Builds a TxEnv from a transaction, its sender, and encoded transaction bytes.

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

impl<T> IntoEither for T

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

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

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

Clones self, possibly returning an error.

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

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

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

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeDebug for T
where T: Debug,

impl<T> MaybeSend for T
where T: Send,

impl<T> MaybeSendSync for T

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 568 bytes