Struct exonum_rust_runtime::api::ServiceApiState

pub struct ServiceApiState { /* fields omitted */ }

Provide the current blockchain state snapshot to API handlers.

This structure allows a service API handler to interact with the service instance and other parts of the blockchain.

Methods

impl ServiceApiState

pub fn data(&self) -> BlockchainData<&dyn Snapshot>

Returns readonly access to blockchain data.

pub fn service_data(&self) -> Prefixed<&dyn Snapshot>

Returns readonly access to the data of the executing service.

pub fn snapshot(&self) -> &dyn Snapshot

Returns the access to the entire blockchain snapshot. Use data or service_data for more structure snapshot presentations.

pub fn service_key(&self) -> PublicKey

Returns the service key of this node.

pub fn instance(&self) -> &InstanceDescriptor

Returns information about the executing service.

pub fn status(&self) -> &InstanceStatus

Returns the current status of the service.

pub fn broadcaster(&self) -> Option<Broadcaster>

Returns a transaction broadcaster if the current node is a validator and the service is active (i.e., can process transactions). If these conditions do not hold, returns None.

pub fn generic_broadcaster(&self) -> Broadcaster

Returns a transaction broadcaster regardless of the node status (validator or auditor) and the service status (active or not).

Safety

Transactions for non-active services will not be broadcast successfully; they will be filtered on the receiving nodes as ones that cannot (currently) be processed.

pub fn moved_permanently(&self, new_endpoint: &str) -> MovedPermanentlyError

Creates a new builder for MovedPermanently response.

Trait Implementations

impl Debug for ServiceApiState

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

Formats the value using the given formatter.