Struct ockam_node::Executor

source ·
pub struct Executor { /* private fields */ }
Expand description

Underlying Ockam node executor

This type is a small wrapper around an inner async runtime (tokio by default) and the Ockam router. In most cases it is recommended you use the ockam::node function annotation instead!

Implementations§

source§

impl Executor

source

pub fn new(flow_controls: &FlowControls) -> Self

Create a new Ockam node Executor instance

source

pub async fn start_router(&mut self) -> Result<()>

Start the router asynchronously

source

pub fn execute<F, T>(&mut self, future: F) -> Result<F::Output>where F: Future<Output = Result<T>> + Send + 'static, T: Send + 'static,

Initialise and run the Ockam node executor context

In this background this launches async execution of the Ockam router, while blocking execution on the provided future.

Any errors encountered by the router or provided application code will be returned from this function.

source

pub fn execute_future<F>(future: F) -> Result<F::Output>where F: Future + Send + 'static, F::Output: Send + 'static,

Execute a future and block until a result is returned

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

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

source§

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, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

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