Struct XmlConversionConfig 

pub struct XmlConversionConfig { /* private fields */ }

Holds the configuration for mapping a specific XML format to STAM

Implementations

impl XmlConversionConfig

pub fn new() -> Self

pub fn resolve_baseelements(&mut self) -> Result<(), XmlConversionError>

pub fn from_toml_str(tomlstr: &str) -> Result<Self, String>

Parse the configuration from a TOML string (load the data from file yourself).

pub fn with_debug(self, value: bool) -> Self

pub fn with_provenance(self, value: bool) -> Self

Add provenance information pointing each annotation to the appropriate node in the XML source files where it came from (translates into XPathSelector in Web Annotation output)

pub fn with_prefix( self, prefix: impl Into<String>, namespace: impl Into<String>, ) -> Self

Register an XML namespace with prefix

pub fn with_id_prefix(self, prefix: impl Into<String>) -> Self

A prefix to assign when setting annotation IDs, within this string you can use the special variable {resource} to use the resource ID.

pub fn with_id_strip_suffix(self, suffix: impl Into<String>) -> Self

A suffix to strip when assigning annotation IDs

pub fn with_inject_dtd(self, dtd: impl Into<String>) -> Self

Inject a DTD (for XML entity resolution)

pub fn with_whitespace(self, handling: XmlWhitespaceHandling) -> Self

Set default whitespace handling

pub fn with_element<F>(self, expression: &str, setup: F) -> Self

where F: Fn(XmlElementConfig) -> XmlElementConfig,

Set an element configuration

pub fn add_context(&mut self, key: impl Into<String>, value: Value)

pub fn debug(&self) -> bool

Trait Implementations

impl<'de> Deserialize<'de> for XmlConversionConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.