Struct rsvg::document::Document

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>,
}

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

impl Document

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.

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

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

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.

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

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

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

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

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.