Struct usvg::Tree

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_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 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 paint_servers<F: FnMut(&Paint)>(&self, f: F)

Calls a closure for each Paint in the tree.

Doesn’t guarantee to have unique paint servers. A caller must deduplicate them manually.

pub fn clip_paths<F: FnMut(SharedClipPath)>(&self, f: F)

Calls a closure for each ClipPath in the tree.

Doesn’t guarantee to have unique clip paths. A caller must deduplicate them manually.

pub fn masks<F: FnMut(SharedMask)>(&self, f: F)

Calls a closure for each Mask in the tree.

Doesn’t guarantee to have unique masks. A caller must deduplicate them manually.

pub fn filters<F: FnMut(SharedFilter)>(&self, f: F)

Calls a closure for each Filter in the tree.

Doesn’t guarantee to have unique filters. A caller must deduplicate them manually.

pub fn calculate_abs_transforms(&mut self)

Calculates absolute transforms for all nodes in the tree.

A low-level method. Prefer usvg::Tree::postprocess instead.

pub fn calculate_bounding_boxes(&mut self)

Calculates bounding boxes for all nodes in the tree.

A low-level method. Prefer usvg::Tree::postprocess instead.

pub fn postprocess(&mut self, steps: PostProcessingSteps, fontdb: &Database)

Postprocesses the usvg::Tree.

Must be called after parsing a usvg::Tree.

steps contains a list of additional post-processing steps. This methods performs some operations even when steps is PostProcessingSteps::default().

fontdb is needed only for PostProcessingSteps::convert_text_into_paths. Otherwise you can pass just fontdb::Database::new().

impl Tree

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

Writes usvg::Tree back to SVG.

Trait Implementations§

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Tree

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !UnwindSafe for Tree

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.