Struct tweep::Passage

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

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

Methods

impl Passage

pub fn new(
    header: Output<Result<PassageHeader, ErrorList>>,
    content: Output<Result<PassageContent, ErrorList>>
) -> 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

use tweep::{Parser, Passage, PassageHeader, PassageContent, StoryTitle};
let header = PassageHeader::parse(":: StoryTitle");
let content = StoryTitle::parse(&vec!["A title"]);
let passage = Passage::new(header, content.into_result());
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<'a> Parser<'a> for Passage

type Output = Output<Result<Self, ErrorList>>

The type produced by this parser

type Input = [&'a str]

The type accepted by this parser

fn parse(input: &'a Self::Input) -> Self::Output

Performs the parsing operation and returns the result

impl Positional for Passage

fn set_row(&mut self, row: usize)

Sets the row of the associated Position

fn set_column(&mut self, col: usize)

Sets the column of the associated Position

fn offset_column(&mut self, offset: usize)

Offsets the column of the associated Position by offset

fn offset_row(&mut self, offset: usize)

Offsets the row of the associated Position by offset

fn set_file(&mut self, file: String)

Sets the file name of the associated Position

fn get_position(&self) -> &Position

Get an immutable reference to the associated Position. Unimplemented by default.

fn mut_position(&mut self) -> &mut Position

Get an mutable reference to the associated Position. Unimplemented by default.

fn get_column(&self) -> Option<usize>

Gets the column of the associated Position if it has one

fn get_row(&self) -> Option<usize>

Gets the row of the associated Position if it has one

fn get_file(&self) -> Option<&str>

Gets the file name of the associated Position if it has one

fn with_offset_row(self, offset: usize) -> Self where
    Self: Sized, 

Moves self, calls offset_row with the given offset and returns a new instance with the offset value

fn with_offset_column(self, offset: usize) -> Self where
    Self: Sized, 

Moves self, calls offset_column with the given offset and returns a new instance with the offset value

fn with_column(self, col: usize) -> Self where
    Self: Sized, 

Moves self, calls set_column with the given col value and returns a new instance with the set value

fn with_row(self, row: usize) -> Self where
    Self: Sized, 

Moves self, calls set_row with the given row value and returns a new instance with the set value

fn with_file(self, file: String) -> Self where
    Self: Sized, 

Moves self, calls set_file with the given file value and returns a new instance with the set value