Struct BodyRef 

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

A view of a section body whose bytes are owned by the containing File.

Implementations

impl BodyRef<'_>

Access

pub fn value(&self, value_name: impl AsRef<str>) -> Option<BString>

Retrieves the last matching value in a section with the given value name, if present.

Note that we consider values without separator = non-existing, i.e. [core]\na would not exist. If that’s expected, Self::value_implicit() must be used instead.

pub fn value_implicit(&self, value_name: &str) -> Option<Option<BString>>

Retrieves the last matching value in a section with the given value name, if present, and indicates an implicit value with Some(None), and a non-existing one as None

pub fn values(&self, value_name: &str) -> Vec<BString>

Retrieves all values that have the provided value name. This may return an empty vec, which implies there were no values with the provided key.

pub fn value_names(&self) -> impl Iterator<Item = String> + '_

Returns an iterator visiting all value names in order.

pub fn contains_value_name(&self, value_name: &str) -> bool

Returns true if the section contains the provided value name.

pub fn num_values(&self) -> usize

Returns the number of values in the section.

pub fn is_void(&self) -> bool

Returns if the section is empty. Note that this may count whitespace, see num_values() for another way to determine semantic emptiness.

Trait Implementations

impl<'a> Clone for BodyRef<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for BodyRef<'a>

impl<'a> Debug for BodyRef<'a>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for BodyRef<'a>

type Item = (String, BString)

The type of the elements being iterated over.

type IntoIter = BodyRefIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.