Struct usvg::Tree

pub struct Tree { /* private fields */ }

A nodes tree container.

Implementations

impl Tree

pub fn from_data(data: &[u8], opt: &Options) -> Result<Self, Error>

Parses Tree from the SVG data.

Can contain an SVG string or a gzip compressed data.

pub fn from_str(text: &str, opt: &Options) -> Result<Self, Error>

Parses Tree from the SVG string.

pub fn from_dom(doc: Document, opt: &Options) -> Self

Parses Tree from the svgdom::Document.

An empty Tree will be returned on any error.

pub fn from_file<P: AsRef<Path>>(path: P, opt: &Options) -> Result<Self, Error>

Parses Tree from the file.

pub fn create(svg: Svg) -> Self

Creates a new Tree.

pub fn root(&self) -> Node

Returns the Svg node.

pub fn svg_node(&self) -> Ref<'_, Svg>

Returns the Svg node value.

pub fn defs(&self) -> Node

Returns the Defs node.

pub fn is_in_defs(&self, node: &Node) -> bool

Checks that node is part of the Defs children.

pub fn append_to_defs(&mut self, kind: NodeKind) -> Node

Appends NodeKind to the Defs node.

pub fn defs_by_id(&self, id: &str) -> Option<Node>

Returns defs child node by ID.

pub fn node_by_id(&self, id: &str) -> Option<Node>

Returns renderable node by ID.

If an empty ID is provided, than this method will always return None. Even if tree has nodes with empty ID.

pub fn to_svgdom(&self) -> Document

Converts the document to svgdom::Document.

Used to save document to file for debug purposes.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.