Struct tweep::Passage

pub struct Passage {
    pub header: PassageHeader,
    pub content: PassageContent,
    pub context: FullContext,
}

A complete Twee passage, including header and content

Parse Errors

See PassageHeader and possible PassageContent variants

Parse Warnings

See PassageHeader and possible PassageContent variants

Fields

header: PassageHeader

The header

content: PassageContent

The content

context: FullContext

The context

Implementations

impl Passage

pub fn new(
    header: Output<Result<PassageHeader, ErrorList>>,
    content: Output<Result<PassageContent, ErrorList>>,
    context: FullContext
) -> Output<Result<Self, ErrorList>>

Creates a new Output<Result<Passage, ErrorList>> from the parse output of a PassageHeader and a PassageContent, along with a composed list of Warnings from both

If either header or content contain errors, the result of this will be a list of errors.

Examples

let header = PassageHeader::parse(context);
let content = StoryTitle::parse(context);
let passage = Passage::new(header, content.into_result(), passage_context);
assert!(passage.is_ok());

pub fn metadata(&self) -> &Map<String, Value>

Returns a reference to the metadata contained by the header field

pub fn tags(&self) -> &Vec<String>

Returns a reference to the list of tags contained by the header field

Trait Implementations

impl Debug for Passage

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

Formats the value using the given formatter.

impl From<Passage> for TwinePassage

fn from(passage: Passage) -> Self

Performs the conversion.