ec4rs 1.2.0

EditorConfig For Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use crate::rawvalue::RawValue;

/// Trait for types that be parsed out of [`RawValue`]s.
///
/// Types that implement this trait should also implement `Into<RawValue>`.
pub trait PropertyValue: Sized {
    /// Indicates whether a value that is case-insensitively equal to "unset"
    /// should NOT be treated as if the value is unset.
    ///
    /// This will typically be false for non-string properties.
    const MAYBE_UNSET: bool;

    /// The type of value returned on a failed parse.
    type Err;

    /// Parses a value from a not-unset [`RawValue`].
    ///
    /// This usually shouldn't be called directly.
    /// See [`crate::Properties`] or [`RawValue::parse`].
    fn parse(value: &RawValue) -> Result<Self, Self::Err>;
}

/// Trait for types that are associated with property names.
///
/// Types that implement this trait will usually also implement [`PropertyValue`].
pub trait PropertyKey {
    /// The lowercase string key for this property.
    ///
    /// Used to look up the value in a [`crate::Properties`] map.
    fn key() -> &'static str;
}

/// Tests if the result of parsing the result of an `Into<RawValue>` conversion
/// is *not unequal* to the original value.
#[cfg(test)]
pub fn test_reparse<T, E: std::fmt::Debug>(initial: T)
where
    T: Clone + PropertyValue<Err = E> + Into<RawValue> + std::fmt::Debug + PartialEq,
{
    let written: RawValue = initial.clone().into();
    let result = T::parse(&written).expect("reparse errored");
    assert!(
        !result.ne(&initial),
        "reparsed value is unequal to original; expected `{:?}`, got `{:?}`",
        initial,
        result
    )
}