Enum Value

pub enum Value<'a> {
    SingleLine(Option<Cow<'a, str>>),
    MultiLine(Vec<Option<Cow<'a, str>>>),
}

The value of an Attribute. Since only some values contain multiple lines and single line values do not require additional heap allocation, an Enum is used to represent both variants.

Variants

SingleLine(Option<Cow<'a, str>>)

A single line value.

Example

let object = parse_object("
name:           ACME Company

")?;
let value: Value = "ACME Company".parse()?;
assert_eq!(object[0].value, value);

MultiLine(Vec<Option<Cow<'a, str>>>)

A value spanning over multiple lines.

Example

let object = parse_object("
remarks:        Packet Street 6
                128 Series of Tubes
                Internet

")?;
let value: Value = vec!["Packet Street 6", "128 Series of Tubes", "Internet"].try_into()?;
assert_eq!(object[0].value, value);

Implementations

impl<'a> Value<'a>

pub fn lines(&self) -> usize

The number of lines contained.

Examples

A value with a single line.

let value: Value = "ACME Company".parse()?;
assert_eq!(value.lines(), 1);

A value with multiple lines.

let value: Value = vec!["Packet Street 6", "128 Series of Tubes", "Internet"].try_into()?;
assert_eq!(value.lines(), 3);

pub fn with_content(&self) -> Vec<&str>

The lines that contain content and are non empty.

Example

let remarks = parse_object("
remarks:        I have lots
                 
                to say.

")?;
assert_eq!(remarks[0].value.with_content(), vec!["I have lots", "to say."]);

Trait Implementations

impl<'a> Clone for Value<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl FromStr for Value<'_>

fn from_str(value: &str) -> Result<Self, Self::Err>

Create a new single line value from a string slice.

A valid value may consist of any ASCII character, excluding control characters.

Errors

Returns an error if the value contains invalid characters.

type Err = InvalidValueError

The associated error which can be returned from parsing.

impl Into<Vec<Option<String>>> for Value<'_>

fn into(self) -> Vec<Option<String>>

Converts this type into the (usually inferred) input type.

impl PartialEq<&str> for Value<'_>

fn eq(&self, other: &&str) -> 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 PartialEq<Vec<&str>> for Value<'_>

fn eq(&self, other: &Vec<&str>) -> 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 PartialEq<Vec<Option<&str>>> for Value<'_>

fn eq(&self, other: &Vec<Option<&str>>) -> 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> PartialEq for Value<'a>

fn eq(&self, other: &Value<'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> Serialize for Value<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec<&str>> for Value<'_>

fn try_from(values: Vec<&str>) -> Result<Self, Self::Error>

Create a new value from a vector of string slices, representing the values lines.

Errors

Returns an error if a value contains invalid characters.

Example

let value: Value = vec!["Packet Street 6", "128 Series of Tubes", "Internet"].try_into()?;
assert_eq!(value.lines(), 3);

type Error = InvalidValueError

The type returned in the event of a conversion error.

impl<'a> Eq for Value<'a>

impl<'a> StructuralPartialEq for Value<'a>