Struct tweep::StoryTitle

pub struct StoryTitle {
    pub title: String,
    pub position: Position,
}

The content of a special passage with the StoryTitle name, which will be used as the title for a parsed story

Parse Errors

None

Parse Warnings

None

Examples

use tweep::{Parser, StoryTitle};
let input:Vec<&str> = "Example Story".split('\n').collect();
let out = StoryTitle::parse(&input);
assert_eq!(out.get_output().as_ref().ok().unwrap().title, "Example Story");

Fields

title: String

The title content

position: Position

The position of the content

Trait Implementations

impl Debug for StoryTitle

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

Formats the value using the given formatter.

impl From<StoryTitle> for PassageContent

fn from(t: StoryTitle) -> PassageContent

Performs the conversion.

impl<'a> Parser<'a> for StoryTitle

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 StoryTitle

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 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 get_row(&self) -> Option<usize>

Gets the row of the associated Position if it has one

fn set_row(&mut self, row: usize)

Sets the row of the associated Position

fn offset_row(&mut self, offset: usize)

Offsets the row of the associated Position by offset

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

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

fn set_file(&mut self, file: String)

Sets the file name of the associated Position

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