Struct ConflictingOptionError 

pub struct ConflictingOptionError<'a> { /* private fields */ }

Error indicating that two or more options conflict with each other

This is a helper object for constructing an error message from a list of conflicting option occurrences. An instance of this type can be created using new or pick_from_indexes and printed with report_error.

Implementations

impl<'a> ConflictingOptionError<'a>

pub fn new<T: Into<Vec<OptionOccurrence<'a>>>>(options: T) -> Self

Creates a new ConflictingOptionError from a list of conflicting options.

The vector should contain at least two elements, or the returned error object may panic when formatted.

pub fn pick_from_indexes<const N: usize>( options: Vec<OptionOccurrence<'a>>, indexes: [usize; N], ) -> Self

Creates a new ConflictingOptionError with conflicting options extracted from a vector.

This function retains only the options in the vector whose indexes are specified in indexes. The other options are discarded.

The indexes may be specified in any order as they are sorted in this function.

indexes should contain at least two elements, or the returned error object may panic when formatted. This function panics immediately if indexes contains a duplicate index.

This function is useful for constructing a ConflictingOptionError from the result of parse_arguments. After examining the OptionOccurrence vector returned by the function, the caller can pick the indexes of the conflicting options and pass them to this function.

For example, calling ConflictingOptionError::pick_from_indexes(vec![a, b, c, d, e], [3, 0]) is equivalent to ConflictingOptionError::new([a, d]).

pub fn options(&self) -> &[OptionOccurrence<'a>]

Returns the list of conflicting options.

pub fn to_report(&'a self) -> Report<'a>

Converts this error into a report.

Trait Implementations

impl<'a> Clone for ConflictingOptionError<'a>

fn clone(&self) -> ConflictingOptionError<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ConflictingOptionError<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ConflictingOptionError<'a>

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

Formats the value using the given formatter.

impl<'a> Error for ConflictingOptionError<'a>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<'a> From<&'a ConflictingOptionError<'a>> for Report<'a>

fn from(error: &'a ConflictingOptionError<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ConflictingOptionError<'a>> for Vec<OptionOccurrence<'a>>

fn from(error: ConflictingOptionError<'a>) -> Self

Converts to this type from the input type.

impl From<ConflictingOptionError<'static>> for Error

fn from(source: ConflictingOptionError<'static>) -> Self

Converts to this type from the input type.

impl<'a> From<Vec<OptionOccurrence<'a>>> for ConflictingOptionError<'a>

fn from(options: Vec<OptionOccurrence<'a>>) -> Self

Creates a new ConflictingOptionError from a list of conflicting options.

The vector should contain at least two elements, or the returned error object may panic when formatted.

impl<'a> PartialEq for ConflictingOptionError<'a>

fn eq(&self, other: &ConflictingOptionError<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ConflictingOptionError<'a>

impl<'a> StructuralPartialEq for ConflictingOptionError<'a>