Struct usvg::Options

source ·
pub struct Options {
    pub resources_dir: Option<PathBuf>,
    pub dpi: f32,
    pub font_family: String,
    pub font_size: f32,
    pub languages: Vec<String>,
    pub shape_rendering: ShapeRendering,
    pub text_rendering: TextRendering,
    pub image_rendering: ImageRendering,
    pub default_size: Size,
    pub image_href_resolver: ImageHrefResolver,
}
Expand description

Processing options.

Fields§

§resources_dir: Option<PathBuf>

Directory that will be used during relative paths resolving.

Expected to be the same as the directory that contains the SVG file, but can be set to any.

Default: None

§dpi: f32

Target DPI.

Impacts units conversion.

Default: 96.0

§font_family: String

A default font family.

Will be used when no font-family attribute is set in the SVG.

Default: Times New Roman

§font_size: f32

A default font size.

Will be used when no font-size attribute is set in the SVG.

Default: 12

§languages: Vec<String>

A list of languages.

Will be used to resolve a systemLanguage conditional attribute.

Format: en, en-US.

Default: [en]

§shape_rendering: ShapeRendering

Specifies the default shape rendering method.

Will be used when an SVG element’s shape-rendering property is set to auto.

Default: GeometricPrecision

§text_rendering: TextRendering

Specifies the default text rendering method.

Will be used when an SVG element’s text-rendering property is set to auto.

Default: OptimizeLegibility

§image_rendering: ImageRendering

Specifies the default image rendering method.

Will be used when an SVG element’s image-rendering property is set to auto.

Default: OptimizeQuality

§default_size: Size

Default viewport size to assume if there is no viewBox attribute and the width or height attributes are relative.

Default: (100, 100)

§image_href_resolver: ImageHrefResolver

Specifies the way xlink:href in <image> elements should be handled.

Default: see type’s documentation for details

Implementations§

source§

impl Options

source

pub fn get_abs_path(&self, rel_path: &Path) -> PathBuf

Converts a relative path into absolute relative to the SVG file itself.

If Options::resources_dir is not set, returns itself.

Trait Implementations§

source§

impl Debug for Options

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Options

source§

fn default() -> Options

Returns the “default value” for a type. Read more

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