Struct Reloading 

pub struct Reloading<T> { /* private fields */ }

Given a Path from the user, provides a utility that reloads the file at the path whenever the file is updated

• Use Reloading::get to get the file contents at a given moment
• Use Reloading::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 that's reloaded
    #[clap(long)]
    config: Reloading<PathTo<JsonOf<serde_json::Value>>>,
}

let cli = Cli::parse_from(["app", "--config=./config.json"]);
let current_config = cli.config.get();
let config_rx = cli.config.receiver();

Note: Reloading is powered by notify, which has some known problems, so check out the caveats if you run into trouble

Implementations

impl<T: Clone> Reloading<T>

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: Clone + Send + Sync + 'static> Reloading<T>

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

Get a stream of document changes

Trait Implementations

impl<T: Clone> Clone for Reloading<T>

fn clone(&self) -> Reloading<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Reloading<PathTo<T>>

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

Formats the value using the given formatter.

impl<T: FromReader + Clone + Send + Sync + 'static> FromStr for Reloading<PathTo<T>>

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.