Struct StartDiagramToken

pub struct StartDiagramToken { /* private fields */ }

A token sequence that is around the start keyword ("@startXYZ"). (like "@startuml" or "@startuml ID", "@startuml(id=ID)".)

• @startuml
• @startuml ID
• @startuml(id=ID)

The above ID parts is parsed by DiagramIdToken.

Examples

use plantuml_parser::{StartDiagramToken, ParseContainer};

let input = "@startuml   "; /// the last "   " is rest parts
let (rest, (raws, token)) = StartDiagramToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, "   ");
assert_eq!(combined_raw, "@startuml");
assert_eq!(token.diagram_kind(), "uml");
assert_eq!(token.id(), None);

let input = "@startXYZ diagram_0  rest";
let (rest, (raws, token)) = StartDiagramToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, "  rest");
assert_eq!(combined_raw, "@startXYZ diagram_0");
assert_eq!(token.diagram_kind(), "XYZ");
assert_eq!(token.id(), Some("diagram_0"));

let input = "@startsalt(id=diagram_1) rest";
let (rest, (raws, token)) = StartDiagramToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "@startsalt(id=diagram_1)");
assert_eq!(token.diagram_kind(), "salt");
assert_eq!(token.id(), Some("diagram_1"));

Implementations

impl StartDiagramToken

pub fn parse(input: ParseContainer) -> ParseResult<Self>

Tries to parse StartDiagramToken. (e.g. "@startuml", "@startuml ID", "@startuml(id=ID)".)

pub fn diagram_kind(&self) -> &str

Returns the kind of diagrams. (e.g. XYZ in @startXYZ.)

pub fn id(&self) -> Option<&str>

Returns the ID of the diagram.

Trait Implementations

impl Clone for StartDiagramToken

fn clone(&self) -> StartDiagramToken

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartDiagramToken

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

Formats the value using the given formatter.