Crate pareg_core 

Re-exports

pub use crate::reader::FromRead;

pub use crate::reader::ReadFmt;

pub use crate::reader::Reader;

pub use crate::reader::ReaderChars;

pub use crate::reader::SetFromRead;

Modules

check

This module provides types that allow checking for values even if the given type is parsed.

proc

This module contains raw implementation of proc macros with proc_macro2.

reader

Macros

has_any_key

Checks if string is key value with the given separator or just key with one of the keys.

impl_from_arg_str_with_read

Implements std::str::FromStr and crate::FromArg for type that implements FromRead.

impl_from_str_with_read

Implements std::str::FromStr for type that implements FromRead.

starts_any

Checks if string starts with any of the given values.

Structs

ArgErrCtx

Information about error in command line arguments. Implements Display with user friendly error messages.

ArgError

Errors thrown when parsing arguments.

Pareg

Helper for parsing arguments.

ParegRef

Helper for parsing arguments.

Enums

ArgErrKind

Errors thrown when parsing arguments.

ColorMode

ParseFArg

Argument to parsef describing expected operation.

Constants

DEFAULT_ANOUNCE

Traits

ArgInto

This trait represents a string reference object that can be parsed into a type.

ByRef

Similar to AsRef, but this also gives the option to specify the lifetime of the returned reference.

FromArg

Represents a trait similar to FromStr, in addition it may return type that references the original string slice. If your type already implements FromStr, you can just implement FromArgStr.

FromArgStr

Default implementation for FromArg for types that implement FromStr

Functions

arg_list

Parses multiple values in arg separated by sep.

bool_arg

Parse bool value in a specific way. If the value of lowercase arg is equal to t returns true, if it is equal to f returns false and otherwise returns error.

key_arg

If sep was '=', parses "key=value" into "key" and discards value.

key_mval_arg

If sep was '=', parses "key=value" into "key" and value that is also parsed to the given type.

key_val_arg

If sep was '=', parses "key=value" into "key" and value that is also parsed to the given type.

mval_arg

If sep was '=', parses "key=value" into value that is parsed to the given type.

opt_bool_arg

Parse bool value in a specific way. If the value of lowercase arg is equal to t returns true, if it is equal to f returns false and if it is equal to n returns None. Otherwise returns error.

parse_arg

Parses the given argument using the FromArg trait.

parsef

Parsef implementation. Parse all data in r based on args.

parsef_part

Parsef part implementation. Parse part of data in r, based on args.

split_arg

Splits arg by separator sep and parses each word into a resulting vector.

try_set_arg

Tries to set the value of res to some if it is none. Throws error if it is some.

try_set_arg_with

Tries to set the value of res to some if it is none. Throws error if it is some.

val_arg

If sep was '=', parses "key=value" into value that is parsed to the given type.

Type Aliases

Result

Pareg result type. It is std::result::Result<T, ArgError<'a>>