Struct IncludeSpecifierToken

pub struct IncludeSpecifierToken { /* private fields */ }

A token sequence that is the include specifier (DiagramIdToken) around the include keyword. (like "foo.puml" or "bar.iuml!buz".)

• [relative filepath]
• [relative filepath]![index]
• [relative filepath]![id]

Examples

use plantuml_parser::{IncludeSpecifierToken, ParseContainer};

let input = "filepath_0 rest";
let (rest, (raws, token)) = IncludeSpecifierToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "filepath_0");
assert_eq!(token.filepath(), "filepath_0");
assert_eq!(token.index(), None);
assert_eq!(token.id(), None);

let input = "file_path_1!diagram_2 rest";
let (rest, (raws, token)) = IncludeSpecifierToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "file_path_1!diagram_2");
assert_eq!(token.filepath(), "file_path_1");
assert_eq!(token.index(), None);
assert_eq!(token.id(), Some("diagram_2"));

let input = "file_path_2!4 rest";
let (rest, (raws, token)) = IncludeSpecifierToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "file_path_2!4");
assert_eq!(token.filepath(), "file_path_2");
assert_eq!(token.index(), Some(4));
assert_eq!(token.id(), Some("4"));

Implementations

impl IncludeSpecifierToken

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

Tries to parse IncludeSpecifierToken. (e.g. "foo.puml", "bar.iuml!buz".)

pub fn filepath(&self) -> &str

Returns the filepath specified by include keyword.

pub fn index(&self) -> Option<usize>

Returns the index specified by include keyword if existed.

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

Returns the ID specified by include keyword if existed.

Trait Implementations

impl Clone for IncludeSpecifierToken

fn clone(&self) -> IncludeSpecifierToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeSpecifierToken

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

Formats the value using the given formatter.