baoyachi / duration-str Goto Github PK

View Code? Open in Web Editor NEW

23.0 2.0 9.0 69 KB

duration string parser write by Rust

Home Page: https://docs.rs/duration-str

Rust 100.00%

duration duration-parsing duration-string duration-format deserialize std rust rust-library rust-crate rust-crates

duration-str's People

Contributors

Stargazers

Watchers

Forkers

isgasho thealgorythm remoun cratedistro olofwalker llvm-x86 sno2 kemens leo1003

duration-str's Issues

Support negative durations for time crate

The time crate supports negative Duration, it would be cool if this crate also supported negative value in parse_time.

[request] Serialize impl

Hi,

Thank you for this crate!

I'm not sure how difficult this is, but can we have the Serialize impl as well? So we can go back and forth?
Of course, if you have some spare time.

Thanks,
Nico

Support accurate error reporting

Make it work with StructOpt

 #[structopt(short, long, parse(/*a structopt compatible parser*/))]
    pub duration: Duration,

motivation

Sometimes when use config duration-str into xxx.toml file. But to ensure safety, in code also add config duration check.
So add check config validate function is very useful.

`duration-str` does not export its `Result` or `Error` type

I needed to write a wrapper around one of the parse functions to make it play nicely with clap's derive functionality, but I found I could not do this without introducing a dependency on anyhow since aliases for the error and result types used aren't available in the crate directly.

Formats duration into a human-readable string

See detail:https://docs.rs/humantime/2.1.0/humantime/fn.format_duration.html

Support missing units for TimeUnit

#32

Support Option<Duration> deserialize

Support decimal point

Optional fields fail to deserialize when missing

When using deserialize_option_duration_time and deserializing a yaml file, if the field is missing from the yaml file, serde_yaml::from_reader will raise an error that the field is missing. This should not happen for fields of type Option<T>.

#[derive(Default, Deserialize)]
pub struct Config {
    pub default_shell: Option<ShellType>,
    #[serde(deserialize_with = "deserialize_option_duration_time")]
    pub session_lifetime: Option<time::Duration>,
}

impl Config {
    pub fn load(config_dir: &Path) -> Result<Self> {
        let config_file_path = config_dir.join("config.yaml");
        let config_file = match std::fs::File::open(config_file_path) {
            Ok(c) => c,
            Err(e) => {
                eprintln!("Failed to open config file: {e}");
                eprintln!("Using defaults");
                return Ok(Self::default());
            }
        };

        Ok(serde_yaml::from_reader(config_file)?)
    }
}

For these two tests, the first one passes and the second one fails:

    #[test]
    fn test_load_config() -> Result<()> {
        let test_dir = "testdata/test_config1";
        std::fs::create_dir_all(test_dir)?;

        let config_path = test_dir.to_string() + "/config.yaml";
        let mut file = File::create(config_path)?;
        file.write_all(b"default_shell: fish\nsession_lifetime: 6h")?;

        let config = Config::load(&Path::new(test_dir))?;

        assert_eq!(config.default_shell, Some(ShellType::Fish));
        assert_eq!(config.session_lifetime, Some(Duration::hours(6)));

        std::fs::remove_dir_all(test_dir)?;

        Ok(())
    }

    #[test]
    fn test_load_config_missing_field() -> Result<()> {
        let test_dir = "testdata/test_config2";
        std::fs::create_dir_all(test_dir)?;

        let config_path = test_dir.to_string() + "/config.yaml";
        let mut file = File::create(config_path)?;
        file.write_all(b"default_shell: fish")?;

        let config = Config::load(&Path::new(test_dir))?;

        assert_eq!(config.default_shell, Some(ShellType::Fish));
        assert_eq!(config.session_lifetime, None);

        std::fs::remove_dir_all(test_dir)?;

        Ok(())
    }

failures:

---- config::session_tests::test_load_config_missing_field stdout ----
Error: missing field `session_lifetime`

Furthermore, if I remove deserialize_option_duration_time and change session_lifetime to Option<String>, the test does not raise an error for a missing field.

Support wasm

Support time crate Duration

https://docs.rs/time/latest/time/struct.Duration.html

called `Result::unwrap()` on an `Err` value: DSLError("Parsing Error: Error { input: \"\", code: Alpha }")
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Error display is relatively blurry and not precise enough

the code

println!("{:?}",parse("0mxx"));

the output

Err(DSLError("0mxx\n ^\n"))