[][src]Crate tweep

Parser for the Twee 3 interactive fiction format

Work in progress

Structs

Error

Represents an error with an ErrorType and Position

ErrorList

Represents a list of Errors

Output

Represents the output of an operation along with a Vec of any Warnings generated by the operation.

Passage

Represents a complete Twee passage, including header and content

PassageHeader

Represents a passage header, along with the associated Position, tags, and metadata

ScriptContent

Represents the content of a Passage tagged with script, containing script data.

Story

Represents a parsed Twee story

StoryData

Represents a special passage with the name StoryData that contains a JSON blob with various information about the story.

StoryPassages

Represents a full Twee story, but stores the full Passage object of each field.

StoryTitle

Represents a passage with the StoryTitle name, which will be used as the title for the story

StylesheetContent

Represents the content of a Passage tagged with stylesheet, containing CSS data.

TwineContent

Represents the content of a Twine passage.

TwineLink

Represents a link to a twee passage contained within a twee passage

Warning

Represents a warning with a WarningType, Position, and optionally a reference to another Position

Enums

ErrorType

Represents the types of errors that can be generated by tweep

PassageContent

Represents the types of content that can be inside a Passage

Position

Represents a position within the content of a Twee story. By default, a Position is a global StoryLevel. Additional context can be added from there to create a position at File, row, and column level.

WarningType

Represents the types of warnings that can be produced by tweep

Traits

Parser

This trait represents a parser which takes a reference to some input of type Input and parses it to produce an output of type Output

Positional

This trait represents something that has one or more Positions associated with it, which can be manipulated through the interface provided.