svgwriter 0.1.1

Typed SVG Writer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

#![allow(
	clippy::tabs_in_doc_comments,
	invalid_doc_attributes,
	unused_attributes
)]
#![warn(rust_2018_idioms)]
#![forbid(unsafe_code)]

//! `svgwriter` is a typed library for writing correct SVG files. It includes SVG
//! specification and documentation from [mdn](https://developer.mozilla.org).
//!
//! ## Example
//!
//! ```rust
//! # use std::fmt::Write as _;
//! use svgwriter::{
//! 	tags::{Path, TagWithPresentationAttributes as _},
//! 	Data, Graphic
//! };
//!
//! let mut svg = Graphic::new();
//! let size = 100;
//! svg.set_width(size);
//! svg.set_height(size);
//! svg.set_view_box(format!("0 0 {size} {size}"));
//!
//! // draw a heart, inspired by https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d#example
//! let d = 40;
//! let padding = size / 2 - d;
//! let mut heart = Data::new();
//! heart
//! 	.move_to(padding, padding + d / 2)
//! 	.arc_by(d / 2, d / 2, 0, false, true, d, 0)
//! 	.arc_by(d / 2, d / 2, 0, false, true, d, 0)
//! 	.quad_by(0, d * 3 / 4, -d, d * 3 / 2)
//! 	.quad_by(-d,-d * 3 / 4, -d, -d * 3 / 2);
//! svg.push(
//! 	Path::new()
//! 		.with_d(heart)
//! 		.with_fill("#A919FA")
//! 		.with_fill_opacity(0.5)
//! 		.with_stroke("#A919FA")
//! 		.with_stroke_width(3)
//! );
//!
//! // write the svg to a file
//! # let mut file = String::new();
//! write!(file, "{}", svg.to_string());
//! # assert_eq!(file, "<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='100' height='100' viewBox='0 0 100 100'><path d='M10,30a20,20,0,0,1,40,0a20,20,0,0,1,40,0q0,30,-40,60q-40,-30,-40,-60' fill='#A919FA' fill-opacity='0.5' stroke='#A919FA' stroke-width='3'/></svg>");
//! ```
//!
//! This code produces the following image:
//!
//! <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='100' height='100' viewBox='0 0 100 100'><path d='M10,30a20,20,0,0,1,40,0a20,20,0,0,1,40,0q0,30,-40,60q-40,-30,-40,-60' fill='#A919FA' fill-opacity='0.5' stroke='#A919FA' stroke-width='3'/></svg>
//!
//! ![Image produced by example code](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20xmlns:xlink='http://www.w3.org/1999/xlink'%20width='100'%20height='100'%20viewBox='0%200%20100%20100'%3E%3Cpath%20d='M10,30a20,20,0,0,1,40,0a20,20,0,0,1,40,0q0,30,-40,60q-40,-30,-40,-60'%20fill='%23A919FA'%20fill-opacity='0.5'%20stroke='%23A919FA'%20stroke-width='3'/%3E%3C/svg%3E)

// TODO use xmlwriter crate if it ever creates a new release
#[path = "xmlwriter/src/lib.rs"]
mod xmlwriter;

mod data;
mod graphic;
mod tag;
pub mod tags;
mod transform;
mod value;

pub use data::Data;
pub use graphic::Graphic;
pub use tag::Container;
#[cfg(feature = "raw")]
pub use tag::RawXml;
pub use transform::Transform;
pub use value::Value;