Skip to main content

InlineComments

Enum InlineComments 

Source
#[non_exhaustive]
pub enum InlineComments { None, AfterWhitespace, Anywhere, }
Expand description

Where comments start after values.

Lines that start with ; or # (after whitespace) are always comments.

use std::collections::BTreeMap;
use deser_ini::{DeserializerConfig, InlineComments};

let input = "a = 1;2 ; one\nb = x #y\nc = #fff";
let with = |comments| -> BTreeMap<String, String> {
    DeserializerConfig::builder()
        .inline_comments(comments)
        .build()
        .from_str(input)
        .unwrap()
};
let values = with(InlineComments::AfterWhitespace);
assert_eq!((&*values["a"], &*values["b"], &*values["c"]), ("1;2", "x", "#fff"));
let values = with(InlineComments::None);
assert_eq!((&*values["a"], &*values["b"], &*values["c"]), ("1;2 ; one", "x #y", "#fff"));
let values = with(InlineComments::Anywhere);
assert_eq!((&*values["a"], &*values["b"], &*values["c"]), ("1", "x", ""));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

None

There are no comments after values (like Python’s configparser).

§

AfterWhitespace

A ; that follows whitespace starts a comment and so does a # that follows whitespace after the value.

Values can contain ; and # that do not follow whitespace (1;2) and start with # (#ff0000).

§

Anywhere

; and # start comments anywhere (outside of quoted values).

Trait Implementations§

Source§

impl Clone for InlineComments

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 Copy for InlineComments

Source§

impl Debug for InlineComments

Source§

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

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

impl Default for InlineComments

Source§

fn default() -> Self

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

impl Eq for InlineComments

Source§

impl PartialEq for InlineComments

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 StructuralPartialEq for InlineComments

Auto Trait Implementations§

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.