Struct SourceSet 

pub struct SourceSet { /* private fields */ }

The sources one argument accepts.

Implementations

impl SourceSet

pub fn new<I: IntoIterator<Item = SourceScheme>>(schemes: I) -> Self

Exactly the listed schemes, in the order they will be documented.

pub fn config() -> Self

The two sources a value can come from without a terminal or a pipe: an environment variable, or an address in a document. This is the set most arguments want.

pub fn stream() -> Self

SourceSet::config plus the streams — for a value that may be piped in, handed over on an inherited descriptor, or typed by a person.

pub fn host_scheme( self, name: impl Into<String>, syntax: impl Into<String>, ) -> Self

Declare a scheme this crate does not implement. The host parses and reads it; this only teaches help and validation that it exists.

pub fn schemes(&self) -> &[SourceScheme]

pub fn host_schemes(&self) -> &[HostScheme]

pub fn accepts(&self, scheme: SourceScheme) -> bool

pub fn is_empty(&self) -> bool

pub fn syntax_summary(&self) -> String

The syntax line help and --docs render, so an about string never has to repeat it.

pub fn parse(&self, raw: &str) -> Result<ValueSource, SourceError>

Classify one argument value. Pure: nothing is opened, read, or asked for, so an argv that names an unacceptable source is rejected as a usage error before any of it can happen.

Trait Implementations

impl Clone for SourceSet

fn clone(&self) -> SourceSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceSet

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

Formats the value using the given formatter.

impl Default for SourceSet

fn default() -> SourceSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SourceSet

impl PartialEq for SourceSet

fn eq(&self, other: &SourceSet) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SourceSet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourceSet