Struct tweep::PassageHeader

pub struct PassageHeader {
    pub name: String,
    pub tags: Vec<String>,
    pub metadata: Map<String, Value>,
}

A passage header, along with associated Position, tags, and metadata

Parse Errors

• LeadingWhitespace - Whitespace before the :: sigil on a header line
• MissingSigil - No :: sigil at the beginning of the header line
• MetadataBeforeTags - Metadata and tags present but in wrong order
• UnclosedTagBlock - Tag block present but unclosed
• UnescapedOpenCurly - Unescaped { character in passage name
• UnescapedCloseCurly - Unescaped } character in passage name
• UnescapedOpenSquare - Unescaped [ character in passage name
• UnescapedCloseSquare - Unescaped ] character in passage name
• EmptyName - No passage name present in header line

Parse Warnings

• JsonError - Error encountered when parsing metadata
• EscapedOpenCurly - \{ present in passage name
• EscapedCloseCurly - \} present in passage name
• EscapedOpenSquare - \[ present in passage name
• EscapedCloseSquare - \] present in passage name

Examples

use tweep::{FullContext, PassageHeader};
let input = r#":: A passage [ tag1 tag2 ] { "position": "5,5" }"#;
let context = FullContext::from(None, input.to_string());
let header = PassageHeader::parse(context);

Fields

name: String

The name of the header. This can be a Twine passage name or a special name

tags: Vec<String>

The list of comma separated tags

metadata: Map<String, Value>

A json object containing metadata for the passage

Implementations

impl PassageHeader

pub fn has_tag(&self, tag: &str) -> bool

Returns true if this header is tagged with str

Examples

use tweep::{FullContext, PassageHeader};
let context = FullContext::from(None, ":: A passage [ foo bar ]".to_string());
let out = PassageHeader::parse(context);
assert!(out.get_output().as_ref().ok().unwrap().has_tag("foo"));

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

Parses a PassageHeader out of the given context

Trait Implementations

impl Debug for PassageHeader

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

Formats the value using the given formatter.