Struct tweep::TwineContent

pub struct TwineContent {
    pub content: String,
    pub position: Position,
    // some fields omitted
}

The contents of a Twine passage.

Contains the content of the passage along with the Position. The get_links method can be used to retrieve all Twine links that were parsed out of the passage.

Parse Errors

None

Parse Warnings

• UnclosedLink - An unclosed Twine link such as `[[Passage Name``
• WhitespaceInLink - Errant whitespace in link such as [[Display Text-> Passage Name]]

Notes

Currently, the supported formats for links are the following:

[[Passge Name]]
[[Display Text|Passage Name]]
[[Display Text->Passage Name]]
[[Passage Name<-Display Text]]

Examples

use tweep::{Parser, Position, TwineContent, TwineLink};
let input:Vec<&str> = r#"This is a Twine content passage. It has a [[link]]
And some [[other link->Another passage]]
"#.split('\n').collect();
let out = TwineContent::parse(&input);
assert_eq!(out.get_output().as_ref().ok().unwrap().get_links(), vec![
   TwineLink { target: "link".to_string(), position: Position::RowColumn(0, 44) },
   TwineLink { target: "Another passage".to_string(), position: Position::RowColumn(1, 11) }]);

Fields

content: String

The content of the passage

position: Position

The position of the passage

Methods

impl TwineContent

pub fn get_links(&self) -> Vec<TwineLink>

Gets a Vec of all the links contained within this content

Trait Implementations

impl Debug for TwineContent

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

Formats the value using the given formatter.

impl From<TwineContent> for PassageContent

fn from(p: TwineContent) -> PassageContent

Performs the conversion.

impl<'a> Parser<'a> for TwineContent

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 TwineContent

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