Struct tweep::StoryData

pub struct StoryData {
    pub ifid: String,
    pub format: Option<String>,
    pub format_version: Option<String>,
    pub start: Option<String>,
    pub tag_colors: Option<HashMap<String, String>>,
    pub zoom: Option<f32>,
}

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

Implementations

impl StoryData

pub fn parse(context: FullContext) -> Output<Result<Option<Self>, ErrorList>>

Parses a StoryData out of the given context

Trait Implementations

impl Debug for StoryData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoryData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<StoryData> for PassageContent

fn from(d: StoryData) -> PassageContent

Performs the conversion.

impl Serialize for StoryData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.