Struct StartLine

pub struct StartLine { /* private fields */ }

A token sequence that is a line containing a start keyword ("@startXYZ") parsed by StartDiagramToken. (like "@startuml\n".)

Examples

use plantuml_parser::{StartLine, ParseContainer};

let input = "@startuml\n";
let (rest, (raws, token)) = StartLine::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, "");
assert_eq!(combined_raw, "@startuml\n");
assert_eq!(token.diagram_kind(), "uml");
assert_eq!(token.id(), None);

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

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

Implementations

impl StartLine

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

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

pub fn inline_block_comment(&self) -> Option<&InlineBlockCommentToken>

Methods from Deref<Target = StartDiagramToken>

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 StartLine

fn clone(&self) -> StartLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartLine

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

Formats the value using the given formatter.

impl Deref for StartLine

type Target = StartDiagramToken

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.