Struct plantuml_parser::IncludeToken

pub struct IncludeToken { /* private fields */ }

A token sequence with IncludeSpecifierToken that is around the include keyword. (like "!include foo.puml" or "!include bar.iuml!buz" , "!include_many foo.puml" or "!include_many bar.iuml!buz".)

• !include [include specifier]
• !include_many [include specifier]
• !include_once [include specifier]

The above include specifier is parsed by IncludeSpecifierToken.

Examples

use plantuml_parser::{IncludeKind, IncludeToken, ParseContainer};

let input = "!include foo.puml rest";
let (rest, (raws, token)) = IncludeToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "!include foo.puml");
assert_eq!(token.filepath(), "foo.puml");
assert_eq!(token.index(), None);
assert_eq!(token.id(), None);
assert_eq!(token.kind(), &IncludeKind::Include);

let input = "!include_many bar.iuml!1 rest";
let (rest, (raws, token)) = IncludeToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "!include_many bar.iuml!1");
assert_eq!(token.filepath(), "bar.iuml");
assert_eq!(token.index(), Some(1));
assert_eq!(token.id(), Some("1"));
assert_eq!(token.kind(), &IncludeKind::IncludeMany);

let input = "!include_once baz.txt!qux rest";
let (rest, (raws, token)) = IncludeToken::parse(input.into())?;
let combined_raw: ParseContainer = raws.into();
assert_eq!(rest, " rest");
assert_eq!(combined_raw, "!include_once baz.txt!qux");
assert_eq!(token.filepath(), "baz.txt");
assert_eq!(token.index(), None);
assert_eq!(token.id(), Some("qux"));
assert_eq!(token.kind(), &IncludeKind::IncludeOnce);

Implementations

impl IncludeToken

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

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

pub fn kind(&self) -> &IncludeKind

Returns the IncludeKind of include keywords.

Methods from Deref<Target = IncludeSpecifierToken>

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 IncludeToken

fn clone(&self) -> IncludeToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeToken

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

Formats the value using the given formatter.

impl Deref for IncludeToken

type Target = IncludeSpecifierToken

The resulting type after dereferencing.

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

Dereferences the value.