Struct BlockComment

pub struct BlockComment { /* private fields */ }

Lines that are representation as block comment. (like "/' begin \n end '/\n".)

• “ /’ begin \n end ’/\n“

Examples

use plantuml_parser::{BlockComment, ParseContainer};

let input = r#"  /' begin comment
in comment
end comment '/
outer"#;
let (rest, (parsed, comment)) = BlockComment::parse(input.into())?;
assert_eq!(rest, "outer");
assert_eq!(parsed, r#"  /' begin comment
in comment
end comment '/
"#);
assert!(comment.is_completed());

let input = "  /' not ending comment \n";
let (rest, (parsed, comment)) = BlockComment::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed, "  /' not ending comment \n");
assert!(!comment.is_completed());

Implementations

impl BlockComment

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

Tries to parse BlockComment. (e.g. "/' begin \n end '/\n".)

pub fn is_completed(&self) -> bool

Returns whether the BlockCommentCloseLine was found.

pub fn lines(&self) -> &[Arc<PlantUmlLine>]

Returns the reference of the list of lines in this block.

Trait Implementations

impl Clone for BlockComment

fn clone(&self) -> BlockComment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockComment

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

Formats the value using the given formatter.

impl Display for BlockComment

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

Formats the value using the given formatter.