Enum RpcModuleSelection 

pub enum RpcModuleSelection {
    All,
    Standard,
    Selection(HashSet<RethRpcModule>),
}

Describes the modules that should be installed.

Example

Create a RpcModuleSelection from a selection.

use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
let config: RpcModuleSelection = vec![RethRpcModule::Eth].into();

Variants

All

Use all available modules.

Standard

The default modules eth, net, web3

Selection(HashSet<RethRpcModule>)

Only use the configured modules.

Implementations

impl RpcModuleSelection

pub const STANDARD_MODULES: [RethRpcModule; 3]

The standard modules to instantiate by default eth, net, web3

pub fn all_modules() -> HashSet<RethRpcModule>

Returns a selection of RethRpcModule with all RethRpcModule::all_variants.

pub fn standard_modules() -> HashSet<RethRpcModule>

Returns the RpcModuleSelection::STANDARD_MODULES as a selection.

pub fn default_ipc_modules() -> HashSet<RethRpcModule>

All modules that are available by default on IPC.

By default all modules are available on IPC.

pub fn try_from_selection<I, T>(selection: I) -> Result<Self, T::Error>

where I: IntoIterator<Item = T>, T: TryInto<RethRpcModule>,

Creates a new unique RpcModuleSelection::Selection from the given items.

Note

This will dedupe the selection and remove duplicates while preserving the order.

Example

Create a selection from the RethRpcModule string identifiers

use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
let selection = vec!["eth", "admin"];
let config = RpcModuleSelection::try_from_selection(selection).unwrap();
assert_eq!(config, RpcModuleSelection::from([RethRpcModule::Eth, RethRpcModule::Admin]));

Create a unique selection from the RethRpcModule string identifiers

use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
let selection = vec!["eth", "admin", "eth", "admin"];
let config = RpcModuleSelection::try_from_selection(selection).unwrap();
assert_eq!(config, RpcModuleSelection::from([RethRpcModule::Eth, RethRpcModule::Admin]));

pub fn len(&self) -> usize

Returns the number of modules in the selection

pub fn is_empty(&self) -> bool

Returns true if no selection is configured

pub const fn is_all(&self) -> bool

Returns true if all modules are selected

pub fn iter_selection(&self) -> Box<dyn Iterator<Item = RethRpcModule> + '_>

Returns an iterator over all configured RethRpcModule

pub fn to_selection(&self) -> HashSet<RethRpcModule>

Clones the set of configured RethRpcModule.

pub fn into_selection(self) -> HashSet<RethRpcModule>

Converts the selection into a HashSet.

pub fn are_identical(http: Option<&Self>, ws: Option<&Self>) -> bool

Returns true if both selections are identical.

pub fn contains(&self, module: &RethRpcModule) -> bool

Returns true if the selection contains the given module.

pub fn push(&mut self, module: RethRpcModule)

Adds a module to the selection.

If the selection is All, this is a no-op. Otherwise, converts to a Selection and adds the module.

pub fn append(self, module: RethRpcModule) -> Self

Returns a new selection with the given module added.

If the selection is All, returns All. Otherwise, converts to a Selection and adds the module.

pub fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = RethRpcModule>,

Extends the selection with modules from an iterator.

If the selection is All, this is a no-op. Otherwise, converts to a Selection and adds the modules.

pub fn extended<I>(self, iter: I) -> Self

where I: IntoIterator<Item = RethRpcModule>,

Returns a new selection with modules from an iterator added.

If the selection is All, returns All. Otherwise, converts to a Selection and adds the modules.

Trait Implementations

impl Clone for RpcModuleSelection

fn clone(&self) -> RpcModuleSelection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcModuleSelection

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

Formats the value using the given formatter.

impl Default for RpcModuleSelection

fn default() -> RpcModuleSelection

Returns the “default value” for a type.

impl Display for RpcModuleSelection

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

Formats the value using the given formatter.

impl From<&[RethRpcModule]> for RpcModuleSelection

fn from(s: &[RethRpcModule]) -> Self

Converts to this type from the input type.

impl From<&HashSet<RethRpcModule>> for RpcModuleSelection

fn from(s: &HashSet<RethRpcModule>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[RethRpcModule; N]> for RpcModuleSelection

fn from(s: [RethRpcModule; N]) -> Self

Converts to this type from the input type.

impl From<HashSet<RethRpcModule>> for RpcModuleSelection

fn from(s: HashSet<RethRpcModule>) -> Self

Converts to this type from the input type.

impl From<Vec<RethRpcModule>> for RpcModuleSelection

fn from(s: Vec<RethRpcModule>) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a RethRpcModule> for RpcModuleSelection

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = &'a RethRpcModule>,

Creates a value from an iterator.

impl FromIterator<RethRpcModule> for RpcModuleSelection

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = RethRpcModule>,

Creates a value from an iterator.

impl FromStr for RpcModuleSelection

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for RpcModuleSelection

fn eq(&self, other: &RpcModuleSelection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RpcModuleSelection

impl StructuralPartialEq for RpcModuleSelection

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: 56 bytes

Size for each variant:

• All: 0 bytes
• Standard: 0 bytes
• Selection: 48 bytes