Struct sc_rpc::system::System

source · [−]

pub struct System<B: Block> { /* private fields */ }

Expand description

System API implementation

Implementations

source

impl<B: Block> System

source

pub fn new(
 info: SystemInfo,
 send_back: TracingUnboundedSender<Request>,
 deny_unsafe: DenyUnsafe
) -> Self

Creates new System.

The send_back will be used to transmit some of the requests. The user is responsible for reading from that channel and answering the requests.

Trait Implementations

source

impl<B: Block> SystemApi<::Hash, <::Header as Header>::Number> for System

source

fn system_name(&self) -> Result<String>

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

source

fn system_version(&self) -> Result<String>

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

source

fn system_chain(&self) -> Result<String>

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

source

fn system_type(&self) -> Result<ChainType>

Get the chain’s type.

source

fn system_properties(&self) -> Result<Properties>

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

source

fn system_health(&self) -> Receiver<Health>

Return health status of the node. Read more

source

fn system_local_peer_id(&self) -> Receiver<String>

Returns the base58-encoded PeerId of the node.

source

fn system_local_listen_addresses(&self) -> Receiver<Vec<String>>

Returns the multiaddresses that the local node is listening on Read more

source

fn system_peers(
&self
) -> Compat<BoxFuture<'static, Result<Vec<PeerInfo<B::Hash, <B::Header as HeaderT>::Number>>>>>

Returns currently connected peers

source

fn system_network_state(&self) -> Compat<BoxFuture<'static, Result<Value>>>

Returns current state of the network. Read more

source

fn system_add_reserved_peer(
&self,
peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

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

source

fn system_remove_reserved_peer(
&self,
peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

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

source

fn system_node_roles(&self) -> Receiver<Vec<NodeRole>>

Returns the roles the node is running as.

source

fn system_sync_state(
&self
) -> Receiver<SyncState<<B::Header as HeaderT>::Number>>

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

source

fn system_add_log_filter(&self, directives: String) -> Result<(), Error>

Adds the supplied directives to the current log filter Read more

source

fn system_reset_log_filter(&self) -> Result<(), Error>

Resets the log filter to Substrate defaults

source

fn to_delegate<M>(self) -> IoDelegate<Self, M> where
 M: Metadata,
 Hash: 'static + Send + Sync + Serialize,
 Number: 'static + Send + Sync + Serialize,

Create an IoDelegate, wiring rpc calls to the trait methods.

Auto Trait Implementations

impl !RefUnwindSafe for System

impl Send for System

impl Sync for System

impl Unpin for System

impl !UnwindSafe for System

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

impl<T> From<T> for T

const: unstable · 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, 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

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

Implementations

impl<B: Block> System<B>

pub fn new( info: SystemInfo, send_back: TracingUnboundedSender<Request<B>>, deny_unsafe: DenyUnsafe) -> Self

Trait Implementations

impl<B: Block> SystemApi<<B as Block>::Hash, <<B as Block>::Header as Header>::Number> for System<B>

fn system_name(&self) -> Result<String>

fn system_version(&self) -> Result<String>

fn system_chain(&self) -> Result<String>

fn system_type(&self) -> Result<ChainType>

fn system_properties(&self) -> Result<Properties>

fn system_health(&self) -> Receiver<Health>

fn system_local_peer_id(&self) -> Receiver<String>

fn system_local_listen_addresses(&self) -> Receiver<Vec<String>>

fn system_peers( &self) -> Compat<BoxFuture<'static, Result<Vec<PeerInfo<B::Hash, <B::Header as HeaderT>::Number>>>>>

fn system_network_state(&self) -> Compat<BoxFuture<'static, Result<Value>>>

fn system_add_reserved_peer( &self, peer: String) -> Compat<BoxFuture<'static, Result<(), Error>>>

fn system_remove_reserved_peer( &self, peer: String) -> Compat<BoxFuture<'static, Result<(), Error>>>

fn system_node_roles(&self) -> Receiver<Vec<NodeRole>>

fn system_sync_state( &self) -> Receiver<SyncState<<B::Header as HeaderT>::Number>>

fn system_add_log_filter(&self, directives: String) -> Result<(), Error>

fn system_reset_log_filter(&self) -> Result<(), Error>

fn to_delegate<M>(self) -> IoDelegate<Self, M> where M: Metadata, Hash: 'static + Send + Sync + Serialize, Number: 'static + Send + Sync + Serialize,

Auto Trait Implementations

impl<B> !RefUnwindSafe for System<B>

impl<B> Send for System<B>

impl<B> Sync for System<B>

impl<B> Unpin for System<B>

impl<B> !UnwindSafe for System<B>

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

pub fn unchecked_into(self) -> T

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

pub fn unique_saturated_into(self) -> T

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new(
info: SystemInfo,
send_back: TracingUnboundedSender<Request<B>>,
deny_unsafe: DenyUnsafe
) -> Self

fn system_peers(
&self
) -> Compat<BoxFuture<'static, Result<Vec<PeerInfo<B::Hash, <B::Header as HeaderT>::Number>>>>>

fn system_add_reserved_peer(
&self,
peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

fn system_remove_reserved_peer(
&self,
peer: String
) -> Compat<BoxFuture<'static, Result<(), Error>>>

fn system_sync_state(
&self
) -> Receiver<SyncState<<B::Header as HeaderT>::Number>>

fn to_delegate<M>(self) -> IoDelegate<Self, M> where
M: Metadata,
Hash: 'static + Send + Sync + Serialize,
Number: 'static + Send + Sync + Serialize,

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