Enum bookbinder_ast::BookEvent

pub enum BookEvent<'a> {
    BeginSemantic(SemanticRole),
    EndSemantic(SemanticRole),
    Event(Event<'a>),
    BeginDivisionHeader(bool),
    EndDivisionHeader(bool),
    DivisionHeaderLabel {
        text: Option<Cow<'a, str>>,
        number: Option<u8>,
        number_format: NumberFormat,
    },
    DivisionAuthors(Vec<Cow<'a, str>>),
    BeginTitlePage,
    BeginTitlePageTitle,
    EndTitlePageTitle,
    BeginTitlePageSubTitle,
    EndTitlePageSubTitle,
    TitlePageContributors(Vec<(TitlePageContributorRole, Vec<Cow<'a, str>>)>),
    EndTitlePage,
    BeginMainmatter,
    BeginFrontmatter,
    BeginBackmatter,
    BeginEpigraphText,
    EndEpigraphText,
    BeginEpigraphSource,
    EndEpigraphSource,
    Null,
}

A particular event in a book, such as the beginning of a paragraph or a span of text

Variants

BeginSemantic(SemanticRole)

EndSemantic(SemanticRole)

Event(Event<'a>)

BeginDivisionHeader(bool)

EndDivisionHeader(bool)

DivisionHeaderLabel

Fields of DivisionHeaderLabel

text: Option<Cow<'a, str>>

the text of this label

number: Option<u8>

the number of this label

number_format: NumberFormat

the format the number of this label should be in

DivisionAuthors(Vec<Cow<'a, str>>)

BeginTitlePage

BeginTitlePageTitle

EndTitlePageTitle

BeginTitlePageSubTitle

EndTitlePageSubTitle

TitlePageContributors(Vec<(TitlePageContributorRole, Vec<Cow<'a, str>>)>)

EndTitlePage

BeginMainmatter

BeginFrontmatter

BeginBackmatter

BeginEpigraphText

EndEpigraphText

BeginEpigraphSource

EndEpigraphSource

Null

Empty event to be ignored

Trait Implementations

impl<'a> Clone for BookEvent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BookEvent<'a>

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

Formats the value using the given formatter.

impl<'a> From<Event<'a>> for BookEvent<'a>

fn from(src: Event<'a>) -> Self

Performs the conversion.

impl<'a> PartialEq<BookEvent<'a>> for BookEvent<'a>

fn eq(&self, other: &BookEvent<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BookEvent<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for BookEvent<'a>

impl<'a> TryFrom<BookEvent<'a>> for Event<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(src: BookEvent<'a>) -> Result<Self, Self::Error>

Performs the conversion.