Struct Periodic 

pub struct Periodic<T, P: Time = Minutes<1>> { /* private fields */ }

Given a Path from the user, provides a utility that reloads the file at the path at a fixed interval

• Use Periodic::get to get the file contents at a given moment
• Use Periodic::receiver to get a tokio watch::Receiver

Example

use clap::Parser;
use clap_adapters::prelude::*;

#[derive(Debug, Parser)]
struct Cli {
    /// Path to a Json config to be reloaded every 24 hours
    #[clap(long)]
    daily_config: Periodic<PathTo<JsonOf<serde_json::Value>>, Hours<24>>,

    /// Path to a Json config to be reloaded every minute
    #[clap(long)]
    minutely_config: Periodic<PathTo<YamlOf<serde_json::Value>>>, // Minutes<1> is the default period

    /// Path to a Json config to be reloaded every second
    #[clap(long)]
    secondly_config: Periodic<PathTo<TomlOf<serde_json::Value>>, Seconds<1>>,
}

#[tokio::main]
async fn main() {
    let cli = Cli::parse_from([
        "app",
        "--daily_config=./daily_config.json",
        "--minutely-config=./minutely_config.yaml",
        "--secondly-config=./secondly_config.toml",
    ]);
    
    let current_config = cli.daily_config.get();
    let current_config = cli.minutely_config.get();
    let current_config = cli.secondly_config.get();
    
    let daily_config_rx = cli.daily_config.receiver();
    let minutely_config_rx = cli.minutely_config.receiver();
    let secondly_config_rx = cli.secondly_config.receiver();
}

Note: Periodic requires a tokio runtime to be active before calling any of the clap::Parser functions

Implementations

impl<T: Clone, P: Time> Periodic<T, P>

pub fn get(&self) -> T

Get the current value of the inner document

pub fn receiver(&self) -> Receiver<T>

Get a receiver channel that yields updated documents after filesystem changes

impl<T, P: Time> Periodic<T, P>

where T: Clone + Send + Sync + 'static,

pub fn stream(&self) -> impl Stream<Item = T>

Get a stream of document changes

Trait Implementations

impl<T: Clone, P: Clone + Time> Clone for Periodic<T, P>

fn clone(&self) -> Periodic<T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, P: Time> Debug for Periodic<PathTo<T>, P>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, P: Time> FromStr for Periodic<PathTo<T>, P>

where T: FromReader + Clone + Send + Sync + 'static,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.