Struct ControlField 

pub struct ControlField<'a> { /* private fields */ }

A field in a control file.

Implementations

impl<'a> ControlField<'a>

pub fn new(name: Cow<'a, str>, value: Cow<'a, str>) -> Self

Construct an instance from a field name and value.

pub fn from_lines( name: Cow<'a, str>, lines: impl Iterator<Item = String>, ) -> Self

Construct an instance from an iterable of lines.

Each line should not have leading whitespace.

pub fn name(&self) -> &str

The name of this field.

pub fn value_str(&self) -> &str

Obtain the value as a &str.

The value’s original file formatting (including newlines and leading whitespace) is included.

pub fn as_simple(&self) -> Result<ControlFieldValue<'a>>

Obtain the value as a ControlFieldValue::Simple if possible.

This will fail if the tracked value has multiple lines.

pub fn as_folded(&self) -> ControlFieldValue<'a>

Obtain the value as a ControlFieldValue::Folded.

pub fn as_multiline(&self) -> ControlFieldValue<'a>

Obtain the value as a ControlFieldValue::Multiline.

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

Obtain an iterator of words in the value.

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

Obtain an iterator of lines in the value.

Leading whitespace from each line is stripped.

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

Obtain an iterator of comma delimited values in the value.

Whitespace surrounding the comma is trimmed.

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

Write the contents of this field to a writer.

Trait Implementations

impl<'a> Clone for ControlField<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ControlField<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ControlField<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for ControlField<'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 ControlField<'a>

fn cmp(&self, other: &ControlField<'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 ControlField<'a>

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

fn partial_cmp(&self, other: &ControlField<'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 ControlField<'a>

impl<'a> StructuralPartialEq for ControlField<'a>