Struct rsvg::document::Document

source ·
pub struct Document {
    tree: Node<NodeData>,
    session: Session,
    ids: HashMap<String, Node<NodeData>>,
    resources: RefCell<Resources>,
    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.

§resources: RefCell<Resources>

Othewr SVG documents and images referenced from this document.

This requires requires interior mutability because we load resources all over the place. Eventually we’ll be able to do this once, at loading time, and keep this immutable.

§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

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

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

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

source

fn lookup_resource(&self, url: &str) -> Result<Resource, LoadingError>

Loads a resource 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.

source

pub fn get_intrinsic_dimensions(&self) -> IntrinsicDimensions

source

pub fn render_document( &self, session: &Session, cr: &Context, viewport: &Rectangle, options: &RenderingOptions ) -> Result<(), InternalRenderingError>

source

pub fn render_layer( &self, session: &Session, cr: &Context, node: Node<NodeData>, viewport: &Rectangle, options: &RenderingOptions ) -> Result<(), InternalRenderingError>

source

fn geometry_for_layer( &self, session: &Session, node: Node<NodeData>, viewport: Rect, options: &RenderingOptions ) -> Result<(Rect, Rect), InternalRenderingError>

source

pub fn get_geometry_for_layer( &self, session: &Session, node: Node<NodeData>, viewport: &Rectangle, options: &RenderingOptions ) -> Result<(Rectangle, Rectangle), InternalRenderingError>

source

fn get_bbox_for_element( &self, session: &Session, node: &Node<NodeData>, options: &RenderingOptions ) -> Result<BoundingBox, InternalRenderingError>

source

pub fn get_geometry_for_element( &self, session: &Session, node: Node<NodeData>, options: &RenderingOptions ) -> Result<(Rectangle, Rectangle), InternalRenderingError>

Returns (ink_rect, logical_rect)

source

pub fn render_element( &self, session: &Session, cr: &Context, node: Node<NodeData>, element_viewport: &Rectangle, options: &RenderingOptions ) -> Result<(), InternalRenderingError>

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

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

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where 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 T
where 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 T
where 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.