Struct Body

pub struct Body<'event>(/* private fields */);

A opaque type that represents a section body.

Implementations

impl<'event> Body<'event>

Access

pub fn value(&self, value_name: impl AsRef<str>) -> Option<Cow<'_, BStr>>

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<Cow<'_, BStr>>>

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<Cow<'_, BStr>>

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 = &ValueName<'event>>

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<'event> Clone for Body<'event>

fn clone(&self) -> Body<'event>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'event> Debug for Body<'event>

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

Formats the value using the given formatter.

impl<'event> Default for Body<'event>

fn default() -> Body<'event>

Returns the “default value” for a type.

impl<'event> Hash for Body<'event>

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<'event> IntoIterator for Body<'event>

type Item = (ValueName<'event>, Cow<'event, BStr>)

The type of the elements being iterated over.

type IntoIter = BodyIter<'event>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'event> Ord for Body<'event>

fn cmp(&self, other: &Body<'event>) -> 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<'event> PartialEq for Body<'event>

fn eq(&self, other: &Body<'event>) -> 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<'event> PartialOrd for Body<'event>

fn partial_cmp(&self, other: &Body<'event>) -> 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<'event> Eq for Body<'event>

impl<'event> StructuralPartialEq for Body<'event>