Struct PathTo

pub struct PathTo<T> {
    pub path: PathBuf,
    pub data: T,
}

An adapter for automatically loading the contents of a file path

Fields

path: PathBuf

The path given as an argument by the user

data: T

The data extracted from the file at the path

Implementations

impl<T> PathTo<JsonOf<T>>

pub fn data(&self) -> &T

Returns reference to the inner JSON datatype

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<JsonOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config of {"hello":"world"} to the config file
let config = serde_json::json!({"hello": "world"});
let config_string = serde_json::to_string(&config)?;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let data = cli.config.data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(data, &serde_json::json!({"hello":"world"}));

pub fn into_data(self) -> T

Returns reference to the inner JSON datatype

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<JsonOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config of {"hello":"world"} to the config file
let config = serde_json::json!({"hello": "world"});
let config_string = serde_json::to_string(&config)?;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let data = cli.config.into_data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(data, serde_json::json!({"hello":"world"}));

impl<T> PathTo<TomlOf<T>>

pub fn data(&self) -> &T

Returns a reference to the inner Toml datatype

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<TomlOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config to the config file
let config_string = r#"hello = "world""#;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let value = cli.config.data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(value, &serde_json::json!({"hello":"world"}));

pub fn into_data(self) -> T

Returns the owned inner datatype parsed from Toml

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<TomlOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config to the config file
let config_string = r#"hello = "world""#;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let data = cli.config.into_data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(data, serde_json::json!({"hello":"world"}));

impl<T> PathTo<YamlOf<T>>

pub fn data(&self) -> &T

Returns reference to the inner Yaml datatype

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<YamlOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config to the config file
let config_string = r#"hello: "world""#;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let data = cli.config.data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(data, &serde_json::json!({"hello":"world"}));

pub fn into_data(self) -> T

Returns the owned inner datatype parsed from Yaml

Example

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

#[derive(Debug, Parser)]
struct Cli {
    #[clap(long)]
    config: PathTo<YamlOf<serde_json::Value>>,
}

// Create a config file in a temporary directory
let config_dir = tempfile::tempdir()?;
let config_path = config_dir.path().join("config.json");
let config_path_string = config_path.display().to_string();

// Write a test config to the config file
let config_string = r#"hello: "world""#;
std::fs::write(&config_path, &config_string)?;

// Parse our CLI, passing our config file path to --config
let cli = Cli::parse_from(["app", "--config", &config_path_string]);
let data = cli.config.into_data();

// We should expect the value we get to match what we wrote to the config
assert_eq!(data, serde_json::json!({"hello":"world"}));

Trait Implementations

impl<T: Clone> Clone for PathTo<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: FromReader> FromStr for 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.