Struct plantuml_parser::PlantUmlFileData

pub struct PlantUmlFileData { /* private fields */ }

PlantUML diagrams in the file.

Examples

use plantuml_parser::PlantUmlFileData;

let data = r#"
@startuml diagram_0
Alice -> Bob: Hello
@enduml

@startuml
Bob -> Alice: Hi
@enduml

@startuml diagram_2
Alice -> Bob: How are you?
@enduml
"#;

let filedata = PlantUmlFileData::parse_from_str(data)?;
assert_eq!(filedata.is_empty(), false);
assert_eq!(filedata.len(), 3);
assert_eq!(
    filedata.iter().map(|x| x.inner()).collect::<Vec<_>>(),
    [
        "Alice -> Bob: Hello\n",
        "Bob -> Alice: Hi\n",
        "Alice -> Bob: How are you?\n",
    ]
);

let content_1 = filedata.get(1).unwrap();
assert_eq!(content_1.inner(), "Bob -> Alice: Hi\n");
let content_0 = filedata.get_by_id("diagram_0").unwrap();
assert_eq!(content_0.inner(), "Alice -> Bob: Hello\n");
let content_2 = filedata.get_by_id("diagram_2").unwrap();
assert_eq!(content_2.inner(), "Alice -> Bob: How are you?\n");

Implementations

impl PlantUmlFileData

pub fn parse_from_str<S>(input: S) -> Result<Self, Error>

where S: Into<String>,

Creates a new PlantUmlFileData from the string.

• input - a string to be parsed.

pub fn parse(input: ParseContainer) -> Result<Self, Error>

Creates a new PlantUmlFileData from the inner type (ParseContainer).

• input - a string to be parsed.

pub fn get_by_token(&self, token: &IncludeToken) -> Option<&PlantUmlContent>

Returns the one PlantUML diagram specified by the token.

• token - A IncludeToken to get PlantUmlContent in the PlantUmlFileData.

pub fn get(&self, index: usize) -> Option<&PlantUmlContent>

Returns the reference to PlantUmlContent of index.

pub fn get_by_id(&self, id: &str) -> Option<&PlantUmlContent>

Returns the reference to PlantUmlContent of id.

pub fn iter(&self) -> Iter<'_, PlantUmlContent>

Returns an iterator visiting all PlantUmlContent in the PlantUmlFileData.

pub fn is_empty(&self) -> bool

Returns true if the PlantUmlFileData has no PlantUmlContent.

pub fn len(&self) -> usize

Returns the number of PlantUmlContent in the PlantUmlFileData.

Trait Implementations

impl Clone for PlantUmlFileData

fn clone(&self) -> PlantUmlFileData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlantUmlFileData

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

Formats the value using the given formatter.