Struct Section

pub struct Section<'a, T: Keyword> {
    v: Vec<TokVal<'a, T>>,
    first: Option<T>,
    last: Option<T>,
}

A Section is the result of sorting a document’s entries by keyword.

TODO: I’d rather have this be pub(crate), but I haven’t figured out how to make that work.

Fields

v: Vec<TokVal<'a, T>>

Map from Keyword index to TokVal

first: Option<T>

The keyword that appeared first in this section. This will be set if v is nonempty.

last: Option<T>

The keyword that appeared last in this section. This will be set if v is nonempty.

Implementations

impl<'a, T: Keyword> Section<'a, T>

fn new() -> Self

Make a new empty Section.

fn tokval(&self, t: T) -> &TokVal<'a, T>

Helper: return the tokval for some Keyword.

pub(crate) fn slice(&self, t: T) -> &[Item<'a, T>]

Return all the Items for some Keyword, as a slice.

pub(crate) fn get(&self, t: T) -> Option<&Item<'a, T>>

Return a single Item for some Keyword, if there is exactly one.

pub(crate) fn required(&self, t: T) -> Result<&Item<'a, T>>

Return a single Item for some Keyword, giving an error if there is not exactly one.

It is usually a mistake to use this function on a Keyword that is not required.

pub(crate) fn maybe<'b>(&'b self, t: T) -> MaybeItem<'b, 'a, T>

Return a proxy MaybeItem object for some keyword. A MaybeItem is used to represent an object that might or might not be there.

pub(crate) fn first_item(&self) -> Option<&Item<'a, T>>

Return the first item that was accepted for this section, or None if no items were accepted for this section.

pub(crate) fn last_item(&self) -> Option<&Item<'a, T>>

Return the last item that was accepted for this section, or None if no items were accepted for this section.

fn add_tok(&mut self, t: T, item: Item<'a, T>)

Insert an item.

The item must have parsed Keyword t.