Struct Endpoint 

pub struct Endpoint<State>(/* private fields */);

An action that can be invoked as a service.

Implementations

impl<State> Endpoint<State>

pub fn new<Args>( action: impl Handler<Args, State> + Send + Sync + 'static, ) -> Self

where State: Clone + Send + Sync + 'static, Args: Clone + Send + Sync + 'static,

Create a new endpoint.

pub fn into_inner(self) -> BoxedAction<State>

Convert this endpoint into the inner action, discarding the endpoint wrapper.

Trait Implementations

impl<State: Clone> Clone for Endpoint<State>

fn clone(&self) -> Endpoint<State>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Args, State> Handler<Args, State> for Endpoint<State>

where State: Clone + Send + 'static, Args: Clone + Send + 'static,

type Future = FrameFuture

Action futures must resolve into an Frame of some kind.

fn invoke(&self, frame: impl Into<Frame>, state: State) -> Self::Future

Invoke the action with a given frame and state, returning the frameual frame that will be produced by the action.

fn context(&self) -> ActionContext<State>

where State: Send + Sync + 'static,

Poll for the action context. This is normally a service, but in some cases, it may be a frame handler or a router.

fn as_into_actionable(&self) -> BoxedAction<State>

where Self: Clone + Send + Sync + 'static, Args: Clone + Send + Sync + 'static, State: Clone + Send + Sync + 'static,

Convert this action into a type erased actionable service.

fn into_stream( self, state: State, ) -> (impl Stream<Item = Result<Frame>>, FrameOutbox)

where Self: Clone + Send + Sync + 'static, Args: Clone + Send + Sync + 'static, State: Clone + Send + Sync + 'static,

Use into_stream to turn the action into a stream and a stream handle. See [Actionable::into_stream] for more information.

fn ready(self, state: State) -> ReadyAction<Self, Args, State>

where Self: Clone + Send + 'static, Args: Clone + Send + 'static, State: Clone + Send + 'static,

Use with_state to turn the action into a stateful action, which can be used as a tower::Service.

fn candidate(self) -> CandidateAction<Self, Args, State>

where Self: Clone + Send + 'static, Args: Clone + Send + 'static, State: Clone + Send + 'static,

Create a Candidate actionable from the action, with the given state. Candidates can be “suspended” by boxing them for later.

fn active(self, state: State) -> ActiveAction

where Self: Clone + Send + Sync + 'static, Args: Clone + Send + Sync + 'static, State: Clone + Send + Sync + 'static,

Create an Active actionable from the action, with the given state.