Struct sc_rpc::system::SystemClient

source · [−]

pub struct SystemClient<Hash, Number> { /* private fields */ }

Expand description

The Client.

Implementations

source

impl<Hash, Number> Client<Hash, Number> where
Hash: 'static + Send + Sync + DeserializeOwned,
Number: 'static + Send + Sync + DeserializeOwned,

source

pub fn new(sender: RpcChannel) -> Client<Hash, Number>

Creates a new Client.

source

pub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>

Get the node’s implementation name. Plain old string.

source

pub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>

Get the node implementation’s version. Should be a semver string.

source

pub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>

Get the chain’s name. Given as a string identifier.

source

pub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>

Get the chain’s type.

source

pub fn system_properties(
&self
) -> impl Future<Item = Map<String, Value>, Error = RpcError>

Get a custom set of properties as a JSON object, defined in the chain spec.

source

pub fn system_health(&self) -> impl Future<Item = Health, Error = RpcError>

Return health status of the node.

Node is considered healthy if it is:

connected to some peers (unless running in dev mode)
not performing a major sync

source

pub fn system_local_peer_id(
&self
) -> impl Future<Item = String, Error = RpcError>

Returns the base58-encoded PeerId of the node.

source

pub fn system_local_listen_addresses(
&self
) -> impl Future<Item = Vec<String, Global>, Error = RpcError>

Returns the multiaddresses that the local node is listening on

The addresses include a trailing /p2p/ with the local PeerId, and are thus suitable to be passed to system_addReservedPeer or as a bootnode address for example.

source

pub fn system_peers(
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>, Global>, Error = RpcError>

Returns currently connected peers

source

pub fn system_network_state(
&self
) -> impl Future<Item = Value, Error = RpcError>

Returns current state of the network.

Warning: This API is not stable. Please do not programmatically interpret its output, as its format might change at any time.

source

pub fn system_add_reserved_peer(
&self,
peer: String
) -> impl Future<Item = (), Error = RpcError>

Adds a reserved peer. Returns the empty string or an error. The string parameter should encode a p2p multiaddr.

/ip4/198.51.100.19/tcp/30333/p2p/QmSk5HQbn6LhUwDiNMseVUjuRYhEtYj4aUZ6WfWoGURpdV is an example of a valid, passing multiaddr with PeerId attached.

source

pub fn system_remove_reserved_peer(
&self,
peer_id: String
) -> impl Future<Item = (), Error = RpcError>

Remove a reserved peer. Returns the empty string or an error. The string should encode only the PeerId e.g. QmSk5HQbn6LhUwDiNMseVUjuRYhEtYj4aUZ6WfWoGURpdV.

source

pub fn system_node_roles(
&self
) -> impl Future<Item = Vec<NodeRole, Global>, Error = RpcError>

Returns the roles the node is running as.

source

pub fn system_sync_state(
&self
) -> impl Future<Item = SyncState<Number>, Error = RpcError>

Returns the state of the syncing of the node: starting block, current best block, highest known block.

source

pub fn system_add_log_filter(
&self,
directives: String
) -> impl Future<Item = (), Error = RpcError>

Adds the supplied directives to the current log filter

The syntax is identical to the CLI <target>=<level>:

sync=debug,state=trace

source

pub fn system_reset_log_filter(
&self
) -> impl Future<Item = (), Error = RpcError>

Resets the log filter to Substrate defaults

Trait Implementations

source

impl<Hash, Number> Clone for Client<Hash, Number> where
Hash: Clone,
Number: Clone,

source

pub fn clone(&self) -> Client<Hash, Number>

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<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
Hash: 'static + Send + Sync + DeserializeOwned,
Number: 'static + Send + Sync + DeserializeOwned,

source

pub fn from(channel: RpcChannel) -> Client<Hash, Number>

Performs the conversion.

Auto Trait Implementations

impl<Hash, Number> !RefUnwindSafe for Client<Hash, Number>

impl<Hash, Number> Send for Client<Hash, Number> where
Hash: Send,
Number: Send,

impl<Hash, Number> Sync for Client<Hash, Number> where
Hash: Sync,
Number: Sync,

impl<Hash, Number> Unpin for Client<Hash, Number> where
Hash: Unpin,
Number: Unpin,

impl<Hash, Number> !UnwindSafe for Client<Hash, Number>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub 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<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

pub fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

pub fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Pointable for T

source

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

source

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

source

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

source

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

source

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> SaturatedConversion for T

source

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

source

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

pub fn unchecked_into(self) -> T

The counterpart to unchecked_from.

source

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

source

pub fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

pub 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

Struct sc_rpc::system::SystemClient

Implementations

impl<Hash, Number> Client<Hash, Number> where Hash: 'static + Send + Sync + DeserializeOwned, Number: 'static + Send + Sync + DeserializeOwned,

pub fn new(sender: RpcChannel) -> Client<Hash, Number>

pub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>

pub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>

pub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>

pub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>

pub fn system_properties( &self) -> impl Future<Item = Map<String, Value>, Error = RpcError>

pub fn system_health(&self) -> impl Future<Item = Health, Error = RpcError>

pub fn system_local_peer_id( &self) -> impl Future<Item = String, Error = RpcError>

pub fn system_local_listen_addresses( &self) -> impl Future<Item = Vec<String, Global>, Error = RpcError>

pub fn system_peers( &self) -> impl Future<Item = Vec<PeerInfo<Hash, Number>, Global>, Error = RpcError>

pub fn system_network_state( &self) -> impl Future<Item = Value, Error = RpcError>

pub fn system_add_reserved_peer( &self, peer: String) -> impl Future<Item = (), Error = RpcError>

pub fn system_remove_reserved_peer( &self, peer_id: String) -> impl Future<Item = (), Error = RpcError>

pub fn system_node_roles( &self) -> impl Future<Item = Vec<NodeRole, Global>, Error = RpcError>

pub fn system_sync_state( &self) -> impl Future<Item = SyncState<Number>, Error = RpcError>

pub fn system_add_log_filter( &self, directives: String) -> impl Future<Item = (), Error = RpcError>

pub fn system_reset_log_filter( &self) -> impl Future<Item = (), Error = RpcError>

Trait Implementations

impl<Hash, Number> Clone for Client<Hash, Number> where Hash: Clone, Number: Clone,

pub fn clone(&self) -> Client<Hash, Number>

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

impl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where Hash: 'static + Send + Sync + DeserializeOwned, Number: 'static + Send + Sync + DeserializeOwned,

pub fn from(channel: RpcChannel) -> Client<Hash, Number>

Auto Trait Implementations

impl<Hash, Number> !RefUnwindSafe for Client<Hash, Number>

impl<Hash, Number> Send for Client<Hash, Number> where Hash: Send, Number: Send,

impl<Hash, Number> Sync for Client<Hash, Number> where Hash: Sync, Number: Sync,

impl<Hash, Number> Unpin for Client<Hash, Number> where Hash: Unpin, Number: Unpin,

impl<Hash, Number> !UnwindSafe for Client<Hash, Number>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T, Outer> IsWrappedBy<Outer> for T where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

pub fn from_ref(outer: &Outer) -> &T

pub fn from_mut(outer: &mut Outer) -> &mut T

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where Self: UniqueSaturatedInto<T>,

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<S, T> UncheckedInto<T> for S where T: UncheckedFrom<S>,

impl<Hash, Number> Client<Hash, Number> where
Hash: 'static + Send + Sync + DeserializeOwned,
Number: 'static + Send + Sync + DeserializeOwned,

pub fn system_properties(
&self
) -> impl Future<Item = Map<String, Value>, Error = RpcError>

pub fn system_local_peer_id(
&self
) -> impl Future<Item = String, Error = RpcError>

pub fn system_local_listen_addresses(
&self
) -> impl Future<Item = Vec<String, Global>, Error = RpcError>

pub fn system_peers(
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>, Global>, Error = RpcError>

pub fn system_network_state(
&self
) -> impl Future<Item = Value, Error = RpcError>

pub fn system_add_reserved_peer(
&self,
peer: String
) -> impl Future<Item = (), Error = RpcError>

pub fn system_remove_reserved_peer(
&self,
peer_id: String
) -> impl Future<Item = (), Error = RpcError>

pub fn system_node_roles(
&self
) -> impl Future<Item = Vec<NodeRole, Global>, Error = RpcError>

pub fn system_sync_state(
&self
) -> impl Future<Item = SyncState<Number>, Error = RpcError>

pub fn system_add_log_filter(
&self,
directives: String
) -> impl Future<Item = (), Error = RpcError>

pub fn system_reset_log_filter(
&self
) -> impl Future<Item = (), Error = RpcError>

impl<Hash, Number> Clone for Client<Hash, Number> where
Hash: Clone,
Number: Clone,

impl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
Hash: 'static + Send + Sync + DeserializeOwned,
Number: 'static + Send + Sync + DeserializeOwned,

impl<Hash, Number> Send for Client<Hash, Number> where
Hash: Send,
Number: Send,

impl<Hash, Number> Sync for Client<Hash, Number> where
Hash: Sync,
Number: Sync,

impl<Hash, Number> Unpin for Client<Hash, Number> where
Hash: Unpin,
Number: Unpin,

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

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

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

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

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

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

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

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

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

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

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,