Struct RouterBuilder

pub struct RouterBuilder<H: RpcHandler> { /* private fields */ }

Builder for creating the RPC router.

This builder allows you to selectively enable endpoints for the router, and a fallback route.

The default is to enable all routes.

Routes

Functions that enable routes are separated into 3 groups:

• json_rpc (enables all of JSON RPC 2.0)
• other_ (e.g. other_get_height)
• bin_ (e.g. bin_get_blocks)

For a list of all monerod routes, see here, or the source file of this type.

Aliases

Some routes have aliases, such as /get_height and /getheight.

These both route to the same handler function, but they do not enable each other.

If desired, you can enable /get_height but not /getheight.

Example

use cuprate_rpc_interface::{RouterBuilder, RpcHandlerDummy};

// Create a router with _only_ `/json_rpc` enabled.
let only_json_rpc = RouterBuilder::<RpcHandlerDummy>::new()
    .json_rpc()
    .build();

// Create a router with:
// - `/get_outs.bin` enabled
// - A fallback enabled
let get_outs_bin_and_fallback = RouterBuilder::<RpcHandlerDummy>::new()
    .bin_get_outs()
    .fallback()
    .build();

// Create a router with all endpoints enabled.
let all = RouterBuilder::<RpcHandlerDummy>::new()
    .all()
    .build();

Implementations

impl<H: RpcHandler> RouterBuilder<H>

pub fn new() -> Self

Create a new Self.

pub fn build(self) -> Router<H>

Build Self into a Router.

All endpoints enabled in RouterBuilder will be enabled in this Router.

pub fn all(self) -> Self

Enable all endpoints, including Self::fallback.

pub fn fallback(self) -> Self

Enable the catch-all fallback route.

Any unknown or disabled route will route here, e.g.:

• get_info
• getinfo
• asdf

pub fn json_rpc(self) -> Self

Enable the /json_rpc endpoint.

pub fn other_get_height(self) -> Self

Enable the /get_height endpoint.

pub fn other_getheight(self) -> Self

Enable the /getheight endpoint.

pub fn other_get_transactions(self) -> Self

Enable the /get_transactions endpoint.

pub fn other_gettransactions(self) -> Self

Enable the /gettransactions endpoint.

pub fn other_get_alt_blocks_hashes(self) -> Self

Enable the /get_alt_blocks_hashes endpoint.

pub fn other_is_key_image_spent(self) -> Self

Enable the /is_key_image_spent endpoint.

pub fn other_send_raw_transaction(self) -> Self

Enable the /send_raw_transaction endpoint.

pub fn other_sendrawtransaction(self) -> Self

Enable the /sendrawtransaction endpoint.

pub fn other_start_mining(self) -> Self

Enable the /start_mining endpoint.

pub fn other_stop_mining(self) -> Self

Enable the /stop_mining endpoint.

pub fn other_mining_status(self) -> Self

Enable the /mining_status endpoint.

pub fn other_save_bc(self) -> Self

Enable the /save_bc endpoint.

pub fn other_get_peer_list(self) -> Self

Enable the /get_peer_list endpoint.

pub fn other_get_public_nodes(self) -> Self

Enable the /get_public_nodes endpoint.

pub fn other_set_log_hash_rate(self) -> Self

Enable the /set_log_hash_rate endpoint.

pub fn other_set_log_level(self) -> Self

Enable the /set_log_level endpoint.

pub fn other_set_log_categories(self) -> Self

Enable the /set_log_categories endpoint.

pub fn other_get_transaction_pool(self) -> Self

Enable the /get_transaction_pool endpoint.

pub fn other_get_transaction_pool_hashes(self) -> Self

Enable the /get_transaction_pool_hashes endpoint.

pub fn other_get_transaction_pool_stats(self) -> Self

Enable the /get_transaction_pool_stats endpoint.

pub fn other_set_bootstrap_daemon(self) -> Self

Enable the /set_bootstrap_daemon endpoint.

pub fn other_stop_daemon(self) -> Self

Enable the /stop_daemon endpoint.

pub fn other_get_net_stats(self) -> Self

Enable the /get_net_stats endpoint.

pub fn other_get_limit(self) -> Self

Enable the /get_limit endpoint.

pub fn other_set_limit(self) -> Self

Enable the /set_limit endpoint.

pub fn other_out_peers(self) -> Self

Enable the /out_peers endpoint.

pub fn other_in_peers(self) -> Self

Enable the /in_peers endpoint.

pub fn other_get_outs(self) -> Self

Enable the /get_outs endpoint.

pub fn other_update(self) -> Self

Enable the /update endpoint.

pub fn other_pop_blocks(self) -> Self

Enable the /pop_blocks endpoint.

pub fn bin_get_blocks(self) -> Self

Enable the /get_blocks.bin endpoint.

pub fn bin_getblocks(self) -> Self

Enable the /getblocks.bin endpoint.

pub fn bin_get_blocks_by_height(self) -> Self

Enable the /get_blocks_by_height.bin endpoint.

pub fn bin_getblocks_by_height(self) -> Self

Enable the /getblocks_by_height.bin endpoint.

pub fn bin_get_hashes(self) -> Self

Enable the /get_hashes.bin endpoint.

pub fn bin_gethashes(self) -> Self

Enable the /gethashes.bin endpoint.

pub fn bin_get_o_indexes(self) -> Self

Enable the /get_o_indexes.bin endpoint.

pub fn bin_get_outs(self) -> Self

Enable the /get_outs.bin endpoint.

pub fn bin_get_transaction_pool_hashes(self) -> Self

Enable the /get_transaction_pool_hashes.bin endpoint.

pub fn bin_get_output_distribution(self) -> Self

Enable the /get_output_distribution.bin endpoint.

Trait Implementations

impl<H: Clone + RpcHandler> Clone for RouterBuilder<H>

fn clone(&self) -> RouterBuilder<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: RpcHandler> Default for RouterBuilder<H>

fn default() -> Self

Uses Self::all.

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