gflow 0.4.15

A lightweight, single-node job scheduler written in 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
46
47

// Use mimalloc only on x86_64 to avoid cross-compilation issues
// ARM cross-compilers don't support the -Wdate-time flag used by libmimalloc-sys
#[cfg(target_arch = "x86_64")]
use mimalloc::MiMalloc;

#[cfg(target_arch = "x86_64")]
#[global_allocator]
static GLOBAL: MiMalloc = MiMalloc;

// Allow referring to this crate as `gflow::...` from within the crate itself.
extern crate self as gflow;

pub mod build_info;
pub mod client;
pub mod config;
pub mod core;
pub mod debug;
pub mod metrics;
pub mod multicall;
pub mod paths;
pub mod platform;
pub mod tls;
pub mod tmux;
pub mod utils;

// Re-export commonly used types for convenience
pub use client::Client;
pub use config::Config;

/// Creates a client from the config file path.
/// This is a convenience function to reduce boilerplate in CLI tools.
///
/// # Example
/// ```no_run
/// use gflow::create_client;
/// use std::path::PathBuf;
///
/// # async fn example() -> anyhow::Result<()> {
/// let config_path: Option<PathBuf> = None;
/// let client = create_client(&config_path)?;
/// # Ok(())
/// # }
/// ```
pub fn create_client(config_path: &Option<std::path::PathBuf>) -> anyhow::Result<Client> {
    let config = config::load_config(config_path.as_ref())?;
    Client::build(&config)
}