[−][src]Struct tweep::StoryData
The content of a special passage with the name StoryData that contains a JSON blob with various information about the story.
JSON fields
Fields as defined by the Twee 3 specification:
- ifid - Rquired. String. Interactive Fiction IDentifier v4 UUID
- format - String. Maps to
. - format-version - String. Maps to
. - start - String. Maps to
of the node whose pid matches . - tag-colors - Object of tag(string):color(string) pairs. Pairs map to
nodes as : . - zoom - Decimal. Maps to
.
Parse Errors
None
Parse Warnings
- [
JsonError
] - Error encountered while parsing the JSON content
Fields
ifid: String
Interactive Fiction IDentifier v4 UUID
format: Option<String>
The story format
format_version: Option<String>
The version of the story format
start: Option<String>
The starting passage
tag_colors: Option<HashMap<String, String>>
Map of tag name to color name for coloring tags
zoom: Option<f32>
Zoom level for editing in Twine
position: Position
The position of the content
Trait Implementations
impl Debug for StoryData
[src]
impl<'de> Deserialize<'de> for StoryData
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl From<StoryData> for PassageContent
[src]
fn from(d: StoryData) -> PassageContent
[src]
impl<'a> Parser<'a> for StoryData
[src]
type Output = Output<Result<Option<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
[src]
impl Positional for StoryData
[src]
fn get_position(&self) -> &Position
[src]
fn mut_position(&mut self) -> &mut Position
[src]
fn get_column(&self) -> Option<usize>
[src]
fn set_column(&mut self, col: usize)
[src]
fn offset_column(&mut self, offset: usize)
[src]
fn get_row(&self) -> Option<usize>
[src]
fn set_row(&mut self, row: usize)
[src]
fn offset_row(&mut self, offset: usize)
[src]
fn get_file(&self) -> Option<&str>
[src]
fn set_file(&mut self, file: String)
[src]
fn with_offset_row(self, offset: usize) -> Self where
Self: Sized,
[src]
Self: Sized,
fn with_offset_column(self, offset: usize) -> Self where
Self: Sized,
[src]
Self: Sized,
fn with_column(self, col: usize) -> Self where
Self: Sized,
[src]
Self: Sized,
fn with_row(self, row: usize) -> Self where
Self: Sized,
[src]
Self: Sized,
fn with_file(self, file: String) -> Self where
Self: Sized,
[src]
Self: Sized,
impl Serialize for StoryData
[src]
Auto Trait Implementations
impl RefUnwindSafe for StoryData
impl Send for StoryData
impl Sync for StoryData
impl Unpin for StoryData
impl UnwindSafe for StoryData
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,