Struct sc_rpc_api::system::gen_client::Client [−][src]
The Client.
Implementations
impl<Hash, Number> Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned, [src]
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
pub fn new(sender: RpcChannel) -> Self[src]
Creates a new Client.
pub fn system_name(&self) -> impl Future<Item = String, Error = RpcError>[src]
Get the node’s implementation name. Plain old string.
pub fn system_version(&self) -> impl Future<Item = String, Error = RpcError>[src]
Get the node implementation’s version. Should be a semver string.
pub fn system_chain(&self) -> impl Future<Item = String, Error = RpcError>[src]
Get the chain’s name. Given as a string identifier.
pub fn system_type(&self) -> impl Future<Item = ChainType, Error = RpcError>[src]
Get the chain’s type.
pub fn system_properties(
&self
) -> impl Future<Item = Properties, Error = RpcError>[src]
&self
) -> impl Future<Item = Properties, Error = RpcError>
Get a custom set of properties as a JSON object, defined in the chain spec.
pub fn system_health(&self) -> impl Future<Item = Health, Error = RpcError>[src]
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
pub fn system_local_peer_id(
&self
) -> impl Future<Item = String, Error = RpcError>[src]
&self
) -> impl Future<Item = String, Error = RpcError>
Returns the base58-encoded PeerId of the node.
pub fn system_local_listen_addresses(
&self
) -> impl Future<Item = Vec<String>, Error = RpcError>[src]
&self
) -> impl Future<Item = Vec<String>, 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.
pub fn system_peers(
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>>, Error = RpcError>[src]
&self
) -> impl Future<Item = Vec<PeerInfo<Hash, Number>>, Error = RpcError>
Returns currently connected peers
pub fn system_network_state(
&self
) -> impl Future<Item = Value, Error = RpcError>[src]
&self
) -> impl Future<Item = Value, Error = RpcError>
Returns current state of the network.
Warning: This API is not stable.
pub fn system_add_reserved_peer(
&self,
peer: String
) -> impl Future<Item = (), Error = RpcError>[src]
&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.
pub fn system_remove_reserved_peer(
&self,
peer_id: String
) -> impl Future<Item = (), Error = RpcError>[src]
&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.
pub fn system_node_roles(
&self
) -> impl Future<Item = Vec<NodeRole>, Error = RpcError>[src]
&self
) -> impl Future<Item = Vec<NodeRole>, Error = RpcError>
Returns the roles the node is running as.
Trait Implementations
impl<Hash: Clone, Number: Clone> Clone for Client<Hash, Number>[src]
impl<Hash, Number> From<RpcChannel> for Client<Hash, Number> where
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned, [src]
Hash: Send + Sync + 'static + DeserializeOwned,
Number: Send + Sync + 'static + DeserializeOwned,
fn from(channel: RpcChannel) -> Self[src]
Auto Trait Implementations
impl<Hash, Number> !RefUnwindSafe for Client<Hash, Number>
impl<Hash, Number> Send for Client<Hash, Number> where
Hash: Send,
Number: Send,
Hash: Send,
Number: Send,
impl<Hash, Number> Sync for Client<Hash, Number> where
Hash: Sync,
Number: Sync,
Hash: Sync,
Number: Sync,
impl<Hash, Number> Unpin for Client<Hash, Number> where
Hash: Unpin,
Number: Unpin,
Hash: Unpin,
Number: Unpin,
impl<Hash, Number> !UnwindSafe for Client<Hash, Number>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> CheckedConversion for T[src]
pub fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>, [src]
Self: TryFrom<T>,
pub fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>, [src]
Self: TryInto<T>,
impl<T> DynClone for T where
T: Clone, [src]
T: Clone,
pub fn __clone_box(&self, Private) -> *mut ()[src]
impl<T> From<T> for T[src]
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T, Outer> IsWrappedBy<Outer> for T where
T: From<Outer>,
Outer: AsRef<T> + AsMut<T> + From<T>, [src]
T: From<Outer>,
Outer: AsRef<T> + AsMut<T> + From<T>,
pub fn from_ref(outer: &Outer) -> &T[src]
Get a reference to the inner from the outer.
pub fn from_mut(outer: &mut Outer) -> &mut T[src]
Get a mutable reference to the inner from the outer.
impl<T> Pointable for T[src]
pub const ALIGN: usize[src]
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize[src]
pub unsafe fn deref<'a>(ptr: usize) -> &'a T[src]
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T[src]
pub unsafe fn drop(ptr: usize)[src]
impl<T> Same<T> for T[src]
type Output = T
Should always be Self
impl<T> SaturatedConversion for T[src]
pub fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>, [src]
Self: UniqueSaturatedFrom<T>,
pub fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>, [src]
Self: UniqueSaturatedInto<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>, [src]
T: UncheckedFrom<S>,
pub fn unchecked_into(self) -> T[src]
impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>, [src]
T: Bounded,
S: TryInto<T>,
pub fn unique_saturated_into(self) -> T[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>, [src]
V: MultiLane<T>,