Crate plantuml_server_client_rs

Crate plantuml_server_client_rs 

Source
Expand description

The client of PlantUML Server.

§Getting Started

Request to http://www.plantuml.com/plantuml/.

cargo install plantuml-server-client-rs
{
  echo '@startuml'
  echo 'Bob -> Alice : hello'
  echo '@enduml'
} | plantuml-server-client > out.svg

§Usages

See README (crates.io)

Structs§

Args
The definition of program arguments. Args has a higher priority than FileConfig. If no value is specified for a configuration item in either Args or FileConfig, the default value is used.
Client
A Client to request to PlantUML Server.
CollectedContainer
A return data type for Collector::collect
Collector
A Collector collect IncludesMetadataItem and include files.
Config
A configuration of plantuml-server-client.
FileConfig
A representation of configuration from file
IncludesMetadata
A metadata about files collected for includes
IncludesMetadataItem
A metadata about file collected for includes
Metadata
A metadata (v1) collected by plantuml-server-client during processing
MetadataItem
A metadata collected by plantuml-server-client during processing
MetadataV2
A metadata collected by plantuml-server-client during processing
PlantUmlMetadata
Information in the generated PlantUML diagrams
PlantUmlMetadataItem
Information in the generated PlantUML diagram
UrlBuilder
A builder to build URLs for PlantUML server

Enums§

Format
A representation of output format of PlantUML Server.
Locate
An wrapper for representing file or stdin / stdout
MetadataVersion
Method
HTTP Method to request
Mode
The mode of execution.

Constants§

PKG_NAME
The package name from Cargo.toml: plantuml-server-client-rs
PKG_VERSION
The package version from Cargo.toml
URL_PREFIX
The default URL prefix

Functions§

init_logger
Initializes tracing logger