Struct AddAttributesToSVGElement 

pub struct AddAttributesToSVGElement {
    pub attributes: BTreeMap<String, String>,
}

Adds attributes to SVG elements in the document. This is not an optimisation and will increase the size of SVG documents.

Differences to SVGO

It’s not possible to set a none value to an attribute. Elements like <svg data-icon /> are valid in HTML but not XML, so it’s only possible to create an attribute like <svg data-icon="" />.

It’s also not possible to create React-like syntax. In SVGO it’s possible to define an attribute as { "key={value}": undefined } to produce an attribute like <svg key={value} />, however in OXVG you have to provide a string value, so it’s output would look like <svg key={value}="" />.

Examples

Add an attribute with a prefix

use std::collections::BTreeMap;
use oxvg_optimiser::{Jobs, AddAttributesToSVGElement};

let jobs = Jobs {
  add_attributes_to_s_v_g_element: Some(AddAttributesToSVGElement {
    attributes: BTreeMap::from([(String::from("prefix:local"), String::from("value"))]),
  }),
  ..Jobs::none()
};

Correctness

This job may visually change documents if the attribute is a presentation attribute or selected via CSS.

No validation is applied to provided attribute and may produce incorrect or invalid documents.

Errors

Never.

If this job produces an error or panic, please raise an issue

Fields

attributes: BTreeMap<String, String>

Pairs of qualified names and attribute values that are assigned to the svg

Trait Implementations

impl Clone for AddAttributesToSVGElement

fn clone(&self) -> AddAttributesToSVGElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddAttributesToSVGElement

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

Formats the value using the given formatter.

impl Default for AddAttributesToSVGElement

fn default() -> AddAttributesToSVGElement

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddAttributesToSVGElement

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AddAttributesToSVGElement

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'input, 'arena> Visitor<'input, 'arena> for AddAttributesToSVGElement

type Error = JobsError<'input>

The type of errors which may be produced by the visitor

fn element( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits a element

fn document( &self, document: &Element<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits the document

fn exit_document( &self, document: &Element<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Exits the document

fn exit_element( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Exits a element

fn doctype( &self, doctype: &'arena Node<'input, 'arena>, ) -> Result<(), Self::Error>

Visits the doctype

fn style(&self, style: &'arena Node<'input, 'arena>) -> Result<(), Self::Error>

Visits the text of a style element

fn text_or_cdata( &self, node: &'arena Node<'input, 'arena>, ) -> Result<(), Self::Error>

Visits a text or cdata node

fn comment( &self, comment: &'arena Node<'input, 'arena>, ) -> Result<(), Self::Error>

Visits a comment

fn processing_instruction( &self, processing_instruction: &'arena Node<'input, 'arena>, context: &Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits a processing instruction

fn prepare( &self, document: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<PrepareOutcome, Self::Error>

After analysing the document, determines whether any extra features such as style parsing or ignoring the tree is needed

fn start( &self, root: &'arena Node<'input, 'arena>, allocator: Allocator<'input, 'arena>, ) -> Result<PrepareOutcome, Self::Error>

Creates context for root and visits it

fn start_with_path( &self, root: &'arena Node<'input, 'arena>, allocator: Allocator<'input, 'arena>, path: Option<PathBuf>, ) -> Result<PrepareOutcome, Self::Error>

Starts visiting the document, adding the path to the visitor’s context

fn start_with_info( &self, root: &Element<'input, 'arena>, info: &Info<'input, 'arena>, flags: Option<ContextFlags>, ) -> Result<PrepareOutcome, Self::Error>

Creates context for root using the provided information and visits it

fn start_with_context( &self, root: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<PrepareOutcome, Self::Error>

Starts visiting the document, using an already existing visitor’s context

fn visit( &self, element: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits an element and it’s children

fn visit_children( &self, parent: &Element<'input, 'arena>, context: &mut Context<'input, 'arena, '_>, ) -> Result<(), Self::Error>

Visits the children of an element