Struct plantuml_parser::PlantUmlLine

pub struct PlantUmlLine { /* private fields */ }

A line of PlantUML

Examples

use plantuml_parser::PlantUmlLine;

// StartLine
let input = "@startuml\n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.start().is_some());
assert!(parsed.diagram_kind().is_some()); // Returns only `StartLine`

// EndLine
let input = "@enduml\n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.end().is_some());

// IncludeLine
let input = "!include foo.puml \n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.include().is_some());

// TitleLine
let input = " title EXAMPLE TITLE\n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.title().is_some());

// HeaderLine
let input = " header EXAMPLE HEADER\n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.header().is_some());

// FooterLine
let input = " footer EXAMPLE FOOTER\n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.footer().is_some());

// EmptyLine
let input = "  ' comment \n";
let (rest, (_, parsed)) = PlantUmlLine::parse(input.into())?;
assert_eq!(rest, "");
assert_eq!(parsed.raw_str(), input);
assert!(parsed.empty().is_some());

Implementations

impl PlantUmlLine

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

Tries to parse PlantUmlLine.

pub fn raw_str(&self) -> &str

Returns the strings.

pub fn start(&self) -> Option<&StartLine>

Returns the StartLine if it is StartLine.

pub fn end(&self) -> Option<&EndLine>

Returns the EndLine if it is EndLine.

pub fn include(&self) -> Option<&IncludeLine>

Returns the IncludeLine if it is IncludeLine.

pub fn title(&self) -> Option<&TitleLine>

Returns the TitleLine if it is TitleLine.

pub fn header(&self) -> Option<&HeaderLine>

Returns the HeaderLine if it is HeaderLine.

pub fn footer(&self) -> Option<&FooterLine>

Returns the FooterLine if it is FooterLine.

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

Returns the kind of the diagram if it is StartLine.

pub fn empty(&self) -> Option<()>

Returns Some(()) if it is EmptyLine.

Trait Implementations

impl Clone for PlantUmlLine

fn clone(&self) -> PlantUmlLine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlantUmlLine

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

Formats the value using the given formatter.