Enum ControlFieldValue 

pub enum ControlFieldValue<'a> {
    Simple(Cow<'a, str>),
    Folded(Cow<'a, str>),
    Multiline(Cow<'a, str>),
}

A field value in a control file.

This represents the value after the colon (:) in field definitions.

There are canonically 3 types of field values: simple, folded, and multiline. The differences between folded and multiline are semantic. folded is logically a single line spanning multiple formatted lines and whitespace is not significant. multiline has similar syntax as folded but whitespace is significant.

Variants

Simple(Cow<'a, str>)

Folded(Cow<'a, str>)

Multiline(Cow<'a, str>)

Implementations

impl<'a> ControlFieldValue<'a>

pub fn iter_lines(&self) -> Box<dyn Iterator<Item = &str> + '_>

Obtain an iterator over string values in this field.

Self::Simple variants will emit a single item.

Self::Folded and Self::Multiline may emit multiple items.

For variants stored as multiple lines, leading whitespace will be trimmed, as necessary.

pub fn iter_words(&self) -> Box<dyn Iterator<Item = &str> + '_>

Obtain an iterator over words in the string value.

The result may be non-meaningful for multiple line variants.

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Write this value to a writer.

pub fn into_inner(self) -> Cow<'a, str>

Obtain the inner string backing this value and consume this instance.

pub fn to_control_field(self, name: Cow<'a, str>) -> ControlField<'a>

Convert this strongly typed value into a ControlField.

Trait Implementations

impl<'a> AsRef<Cow<'a, str>> for ControlFieldValue<'a>

fn as_ref(&self) -> &Cow<'a, str>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for ControlFieldValue<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ControlFieldValue<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for ControlFieldValue<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ControlFieldValue<'a>

fn cmp(&self, other: &ControlFieldValue<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for ControlFieldValue<'a>

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

fn partial_cmp(&self, other: &ControlFieldValue<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for ControlFieldValue<'a>

impl<'a> StructuralPartialEq for ControlFieldValue<'a>