Struct Protocol

pub struct Protocol { /* private fields */ }

Runtime part of the runtime host protocol.

Implementations

impl Protocol

pub fn get_config(&self) -> &Config

The supplied runtime configuration.

pub fn get_identity(&self) -> Option<&Arc<Identity>>

The runtime identity.

pub fn get_runtime_id(&self) -> Namespace

The runtime identifier for this instance.

Panics

Panics, if the host environment information is not set.

pub fn get_host_info(&self) -> HostInfo

The host environment information for this instance.

Panics

Panics, if the host environment information is not set.

pub fn call_host(&self, body: Body) -> Result<Body, Error>

Make a new request to the runtime host and wait for the response.

This is a blocking variant of call_host_async.

Panics

This function panics if called within an asynchronous execution context.

pub async fn call_host_async(&self, body: Body) -> Result<Body, Error>

Make a new request to the runtime host and wait for the response.

pub fn send_response(&self, id: u64, body: Body) -> Result<()>

Send an async response to a previous request back to the host.

pub fn ensure_initialized(&self) -> Result<()>

Ensure that the runtime is ready to process requests and fail otherwise.

Trait Implementations

impl BundleManager for Protocol

fn bundle_write<'life0, 'async_trait>( &'life0 self, args: BundleWriteRequest, ) -> Pin<Box<dyn Future<Output = Result<BundleWriteResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to write a chunk of the bundle to a temporary file.

fn bundle_add<'life0, 'async_trait>( &'life0 self, args: BundleAddRequest, ) -> Pin<Box<dyn Future<Output = Result<BundleAddResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to add a specific bundle to the host.

fn bundle_remove<'life0, 'async_trait>( &'life0 self, args: BundleRemoveRequest, ) -> Pin<Box<dyn Future<Output = Result<BundleRemoveResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to remove a specific component. Only components added by this component can be removed.

fn bundle_list<'life0, 'async_trait>( &'life0 self, args: BundleListRequest, ) -> Pin<Box<dyn Future<Output = Result<BundleListResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to list all bundles.

impl Host for Protocol

fn identity<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<PublicKey, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the identity of the host node.

fn submit_tx<'life0, 'async_trait>( &'life0 self, data: Vec<u8>, opts: SubmitTxOpts, ) -> Pin<Box<dyn Future<Output = Result<Option<TxResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Submit a transaction.

fn register_notify<'life0, 'async_trait>( &'life0 self, opts: RegisterNotifyOpts, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Register for receiving notifications.

fn bundle_manager(&self) -> &dyn BundleManager

Bundle manager interface.

fn volume_manager(&self) -> &dyn VolumeManager

Volume manager interface.

impl VolumeManager for Protocol

fn volume_add<'life0, 'async_trait>( &'life0 self, args: VolumeAddRequest, ) -> Pin<Box<dyn Future<Output = Result<VolumeAddResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to add a volume.

fn volume_remove<'life0, 'async_trait>( &'life0 self, args: VolumeRemoveRequest, ) -> Pin<Box<dyn Future<Output = Result<VolumeRemoveResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to remove volumes.

fn volume_list<'life0, 'async_trait>( &'life0 self, args: VolumeListRequest, ) -> Pin<Box<dyn Future<Output = Result<VolumeListResponse, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request to host to list volumes.