Struct Tree 

pub struct Tree {
    pub(crate) size: Size,
    pub(crate) root: Group,
    pub(crate) linear_gradients: Vec<Arc<LinearGradient>>,
    pub(crate) radial_gradients: Vec<Arc<RadialGradient>>,
    pub(crate) patterns: Vec<Arc<Pattern>>,
    pub(crate) clip_paths: Vec<Arc<ClipPath>>,
    pub(crate) masks: Vec<Arc<Mask>>,
    pub(crate) filters: Vec<Arc<Filter>>,
    pub(crate) fontdb: Arc<Database>,
}

A nodes tree container.

Fields

size: Size

root: Group

linear_gradients: Vec<Arc<LinearGradient>>

radial_gradients: Vec<Arc<RadialGradient>>

patterns: Vec<Arc<Pattern>>

clip_paths: Vec<Arc<ClipPath>>

masks: Vec<Arc<Mask>>

filters: Vec<Arc<Filter>>

fontdb: Arc<Database>

Implementations

impl Tree

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

Parses Tree from an SVG data.

Can contain an SVG string or a gzip compressed data.

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

Similar to the from_data method, except that it ignores all image elements linking to external files, as required by the SVG specification when SVG files are loaded for <image href="..." /> tags.

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

Parses Tree from an SVG string.

pub fn from_xmltree( doc: &Document<'_>, opt: &Options<'_>, ) -> Result<Self, Error>

Parses Tree from roxmltree::Document.

impl Tree

pub fn size(&self) -> Size

Image size.

Size of an image that should be created to fit the SVG.

width and height in SVG.

Note that this does not necessarily represent the bounding box of the rendered contents. Use self.root().abs_layer_bounding_box() to retrieve it instead.

pub fn root(&self) -> &Group

The root element of the SVG tree.

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

Returns a renderable node by ID.

If an empty ID is provided, than this method will always return None.

pub fn has_text_nodes(&self) -> bool

Checks if the current tree has any text nodes.

pub fn has_defs_nodes(&self) -> bool

Checks if the current tree has any defs nodes.

pub fn linear_gradients(&self) -> &[Arc<LinearGradient>]

Returns a list of all unique LinearGradients in the tree.

pub fn radial_gradients(&self) -> &[Arc<RadialGradient>]

Returns a list of all unique RadialGradients in the tree.

pub fn patterns(&self) -> &[Arc<Pattern>]

Returns a list of all unique Patterns in the tree.

pub fn clip_paths(&self) -> &[Arc<ClipPath>]

Returns a list of all unique ClipPaths in the tree.

pub fn masks(&self) -> &[Arc<Mask>]

Returns a list of all unique Masks in the tree.

pub fn filters(&self) -> &[Arc<Filter>]

Returns a list of all unique Filters in the tree.

pub fn fontdb(&self) -> &Arc<Database>

Returns the font database that applies to all text nodes in the tree.

pub(crate) fn collect_paint_servers(&mut self)

impl Tree

pub fn to_string(&self, opt: &WriteOptions) -> String

Writes usvg::Tree back to SVG.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.