Skip to main content

Options

Struct Options 

Source
pub struct Options<'a>(/* private fields */);
Expand description

The options of a function or markup, in source order.

Duplicates are representable, so that validation can report Duplicate Option Name; a valid message has none.

Implementations§

Source§

impl<'a> Options<'a>

Source

pub const fn new() -> Self

No options (does not allocate).

Source

pub fn with_capacity(capacity: usize) -> Self

No options, with room for capacity without reallocating.

Source

pub fn push(&mut self, name: Cow<'a, str>, value: OptionValue<'a>)

Appends an option (duplicates are kept).

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &OptionValue<'a>)>

(identifier, value) pairs, in source order.

Source

pub fn get(&self, name: &str) -> Option<&OptionValue<'a>>

The value of the first option named exactly name.

Source

pub fn len(&self) -> usize

How many options (duplicates included).

Source

pub fn is_empty(&self) -> bool

No options.

Source

pub fn into_owned(self) -> Options<'static>

The same options, owned.

Trait Implementations§

Source§

impl<'a> Clone for Options<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Options<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for Options<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Eq for Options<'a>

Source§

impl<'a> FromIterator<(Cow<'a, str>, OptionValue<'a>)> for Options<'a>

Source§

fn from_iter<I: IntoIterator<Item = (Cow<'a, str>, OptionValue<'a>)>>( iter: I, ) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a> Hash for Options<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> PartialEq for Options<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Options<'_>

Available on crate feature serde only.
Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> StructuralPartialEq for Options<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Options<'a>

§

impl<'a> RefUnwindSafe for Options<'a>

§

impl<'a> Send for Options<'a>

§

impl<'a> Sync for Options<'a>

§

impl<'a> Unpin for Options<'a>

§

impl<'a> UnsafeUnpin for Options<'a>

§

impl<'a> UnwindSafe for Options<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.