Struct FunctionService

pub struct FunctionService<S, F, Fut>
where
    S: Clone + Send + Sync + 'static,
    AppContext: FromRef<S>,
    F: Send + Sync + Fn(S, CancellationToken) -> Fut,
    Fut: Send + Future<Output = RoadsterResult<()>>,
{ /* private fields */ }

A generic Service to allow creating a service from an async function.

Examples

async fn example_service(
    _state: AppContext,
    _cancel_token: CancellationToken,
) -> RoadsterResult<()> {
    // Service logic here
}

type App = RoadsterApp<AppContext>;

let service = FunctionService::builder()
            .name("example".to_string())
            .enabled(true)
            .function(example_service)
            .build();

let app: App = RoadsterApp::builder()
    .add_service(service)
    .build();

Implementations

impl<S, F, Fut> FunctionService<S, F, Fut>

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>, F: Send + Sync + Fn(S, CancellationToken) -> Fut, Fut: Send + Future<Output = RoadsterResult<()>>,

pub fn builder() -> FunctionServiceBuilder<S, F, Fut>

Create an instance of FunctionService using the builder syntax

Trait Implementations

impl<S, F, Fut> Service<S> for FunctionService<S, F, Fut>

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>, F: 'static + Send + Sync + Fn(S, CancellationToken) -> Fut, Fut: 'static + Send + Future<Output = RoadsterResult<()>>,

fn name(&self) -> String

The name of the service.

fn enabled(&self, state: &S) -> bool

Whether the service is enabled. If the service is not enabled, it will not be run.

fn run<'life0, 'async_trait>( self: Box<Self>, state: &'life0 S, cancel_token: CancellationToken, ) -> Pin<Box<dyn Future<Output = RoadsterResult<()>> + Send + 'async_trait>>

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

Run the service in a new tokio task.

fn before_run<'life0, 'life1, 'async_trait>( &'life0 self, _state: &'life1 S, ) -> Pin<Box<dyn Future<Output = RoadsterResult<()>> + Send + 'async_trait>>

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

Perform any initialization work or other checks that should be done before the service runs.