Struct Assembly 

pub struct Assembly<T> {
    pub top: T,
    /* private fields */
}

Main entry point for a Comprehensive server.

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
   comprehensive::Assembly::<TopDependencies>::new()?.run().await
}

Fields

top: T

The constructed instances of the top-level (root) dependencies. Access to this is freqently not required as these resources will work autonomously once included in the graph.

Implementations

impl<T> Assembly<T>

where T: ResourceDependencies,

pub fn new() -> Result<Self, Box<dyn Error>>

Build a new Assembly from the given resources and all their transitive dependencies.

pub fn new_from_argv<I, A>(argv: I) -> Result<Self, Box<dyn Error>>

where I: IntoIterator<Item = A>, A: Into<OsString> + Clone,

Build a new Assembly from the given resources and all their transitive dependencies, with a given command line argv. Mostly for testing.

pub async fn run(self) -> Result<(), Box<dyn Error>>

Run an Assembly by invoking and awaiting every resource in the graph.

Runs until either any Resource terminates with an error, a termination signal is received (and graceful shutdown is finished), or all resources terminate successfully. (Returns immediately on an empty graph.)

pub async fn run_with_termination_signal( self, termination_signal: impl Stream<Item = ()> + Unpin, ) -> Result<(), Box<dyn Error>>

Run an Assembly by invoking and awaiting every resource in the graph.

Callers should usually use Assembly::run instead, which installs a SIGTERM handler and then calls this with it.

pub fn write_graph(w: &mut dyn Write)

Write the constructed graph in Graphviz dot format.

Can be invoked by running an Assembly with the special flag --write_graph_and_exit on the command line.