Struct pikchr::Pikchr

pub struct Pikchr { /* fields omitted */ }

A rendered pikchr diagram

Pikchr renders diagrams as SVG. This SVG is a given width and height. The Pikchr derefs to the SVG string, or you can access it explicitly. The width and height are accessible as plain numbers.

Implementations

impl Pikchr

pub fn render(
    source: &str,
    class: Option<&str>,
    flags: PikchrFlags
) -> Result<Pikchr, String>

Render some input pikchr source as an SVG

You can convert arbitrary pikchr source into an SVG using this function. The class name is optional, and the flags field controls the generation of errors. Since pikchr does not have a structured error format, the returned error is simply a string.

let image = Pikchr::render(r#"
arrow right 200% "Markdown" "Source"
box rad 10px "Markdown" "Formatter" "(markdown.c)" fit
arrow right 200% "HTML+SVG" "Output"
arrow <-> down 70% from last box.s
box same "Pikchr" "Formatter" "(pikchr.c)" fit"#,
     None, PikchrFlags::default())
    .unwrap();
assert!(image.contains("<svg"))

pub fn width(&self) -> isize

Retrieve the width of this Pikchr

println!("Picture is {} pixels wide", pic.width());

pub fn height(&self) -> isize

Retrieve the height of this Pikchr

println!("Picture is {} pixels tall", pic.height());

pub fn rendered(&self) -> &str

Retrieve the rendered pikchr (same as dereferencing)

println!("Picture content:\n{}", pic.rendered());

Trait Implementations

impl Deref for Pikchr

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Pikchr

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

Formats the value using the given formatter.

impl Drop for Pikchr

fn drop(&mut self)

Executes the destructor for this type.