Struct railroad::Diagram

pub struct Diagram<N> { /* private fields */ }

Implementations

impl<N: Node> Diagram<N>

pub fn new(root: N) -> Self

Create a diagram using the given root-element.

use railroad::*;

let mut seq: Sequence::<Box<dyn Node>> = Sequence::default();
seq.push(Box::new(Start))
   .push(Box::new(Terminal::new("Foobar".to_owned())))
   .push(Box::new(End));
let mut dia = Diagram::new(seq);
dia.add_element(svg::Element::new("style")
                .set("type", "text/css")
                .raw_text(DEFAULT_CSS));
println!("{}", dia);

pub fn with_default_css(root: N) -> Self

Create a diagram which has this library’s default CSS style included.

pub fn add_default_css(&mut self)

Add the default CSS as an additional <style> element.

pub fn attr(&mut self, key: String) -> Entry<'_, String, String>

Set an attribute on the

pub fn add_element(&mut self, e: Element) -> &mut Self

Add an additional svg::Element which is written before the root-element

pub fn write(&self, writer: &mut impl Write) -> Result<()>

Write this diagram’s SVG-code to the given writer.

Errors

Returns errors in the underlying writer.

pub fn into_inner(self) -> N

Return the root-element this diagram’s root element

Trait Implementations

impl<N: Clone> Clone for Diagram<N>

fn clone(&self) -> Diagram<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for Diagram<N>

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

Formats the value using the given formatter.

impl<N> Default for Diagram<N>where N: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<N> Display for Diagram<N>where N: Node,

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

Formats the value using the given formatter.

impl<N> Node for Diagram<N>where N: Node,

fn entry_height(&self) -> i64

The vertical distance from this element’s top to where the entering, connecting path is drawn.

fn height(&self) -> i64

This primitives’s total height.

fn width(&self) -> i64

This primitive’s total width.

fn draw(&self, x: i64, y: i64, h_dir: HDir) -> Element

Draw this element as an svg::Element.

fn height_below_entry(&self) -> i64

The vertical distance from the height of the connecting path to the bottom.