Struct rsvg::document::Document

source ·
pub struct Document {
    tree: Node<NodeData>,
    session: Session,
    ids: HashMap<String, Node<NodeData>>,
    externs: RefCell<Resources>,
    images: RefCell<Images>,
    load_options: Arc<LoadOptions>,
    stylesheets: Vec<Stylesheet>,
}
Expand description

A loaded SVG file and its derived data.

Fields§

§tree: Node<NodeData>

Tree of nodes; the root is guaranteed to be an <svg> element.

§session: Session

Metadata about the SVG handle.

§ids: HashMap<String, Node<NodeData>>

Mapping from id attributes to nodes.

§externs: RefCell<Resources>

SVG documents referenced from this document.

§images: RefCell<Images>

Image resources referenced from this document.

§load_options: Arc<LoadOptions>

Used to load referenced resources.

§stylesheets: Vec<Stylesheet>

Stylesheets defined in the document.

Implementations§

source§

impl Document

source

pub fn load_from_stream( session: Session, load_options: Arc<LoadOptions>, stream: &InputStream, cancellable: Option<&Cancellable> ) -> Result<Document, LoadingError>

Constructs a Document by loading it from a stream.

source

pub fn root(&self) -> Node<NodeData>

Gets the root node. This is guaranteed to be an <svg> element.

source

pub fn lookup_node(&self, node_id: &NodeId) -> Option<Node<NodeData>>

Looks up a node in this document or one of its resources by its id attribute.

source

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

Looks up a node in this document by its id attribute.

source

pub fn lookup_image( &self, url: &str ) -> Result<SharedImageSurface, LoadingError>

Loads an image by URL, or returns a pre-loaded one.

source

pub fn cascade(&mut self, extra: &[Stylesheet], session: &Session)

Runs the CSS cascade on the document tree

This uses the default UserAgent stylesheet, the document’s internal stylesheets, plus an extra set of stylesheets supplied by the caller.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

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> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.