steward 0.0.10

Task runner and process manager for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use std::{fmt::Display, future::Future};

use crate::fmt;

/// A function that prints a headline of a task and runs the task ([`Fn`](std::ops::Fn)).
///
/// ```ignore
/// steward::run("Seeding database", || async { Migrator::up().await }).await
/// ```
pub async fn run<Fun, Fut, Ok, Err>(msg: impl Display, f: Fun) -> Result<Ok, Err>
where
    Fun: Fn() -> Fut,
    Fut: Future<Output = Result<Ok, Err>>,
{
    eprintln!("{}", fmt::plain_headline(msg));
    f().await
}

/// A function that prints a headline of a task and runs the task ([`FnMut`](std::ops::FnMut)).
///
/// ```ignore
/// steward::run("Stopping server", || async { process.stop().await }).await
/// ```
pub async fn run_mut<Fun, Fut, Ok, Err>(msg: impl Display, mut f: Fun) -> Result<Ok, Err>
where
    Fun: FnMut() -> Fut,
    Fut: Future<Output = Result<Ok, Err>>,
{
    eprintln!("{}", fmt::plain_headline(msg));
    f().await
}

/// A function that prints a headline of a task and runs the task ([`FnOnce`](std::ops::FnOnce)).
///
/// ```ignore
/// steward::run("Stopping server", || async { process.stop().await }).await
/// ```
pub async fn run_once<Fun, Fut, Ok, Err>(msg: impl Display, f: Fun) -> Result<Ok, Err>
where
    Fun: FnOnce() -> Fut,
    Fut: Future<Output = Result<Ok, Err>>,
{
    eprintln!("{}", fmt::plain_headline(msg));
    f().await
}