Struct xml2json_rs::JsonConfig

pub struct JsonConfig { /* private fields */ }

Configuration options for JsonBuilder

Implementations

impl JsonConfig

JsonBuilder configuration options

pub fn new() -> JsonConfig

Initialze a new JsonConfig instance.

This uses the builder pattern. All options are initialized to None and can be set using selfs methods. Any options not set will use their defaults upon call to finalize.

pub fn charkey<T: Into<String>>(&mut self, key: T) -> &mut JsonConfig

Key to store character content under.

("_" by default)

pub fn attrkey<T: Into<String>>(&mut self, key: T) -> &mut JsonConfig

Key to outer object containing tag attributes.

("$" by default)

pub fn empty_tag<T: Into<String>>(&mut self, key: T) -> &mut JsonConfig

The value of empty nodes.

Can be used if you want to specify a value other than "" for empty nodes. ("" by default)

pub fn explicit_root(&mut self, flag: bool) -> &mut JsonConfig

Sets the root node inside the resulting object.

(true by default)

pub fn trim(&mut self, flag: bool) -> &mut JsonConfig

Trim whitespace at the beginning and end of text nodes.

(false by default)

pub fn ignore_attrs(&mut self, flag: bool) -> &mut JsonConfig

Ingore attributes.

Setting this to true will skip adding element attributes and create text nodes.

(false by default)

pub fn merge_attrs(&mut self, flag: bool) -> &mut JsonConfig

Merge attributes.

Merge all XML attributes and child elements as properties of the parent, instead of keying attributes off of the child attribute object. This option will be ignored if ignore_attrs is set.

(false by default)

pub fn normalize_text(&mut self, flag: bool) -> &mut JsonConfig

Removes whitespace character data in text nodes.

This option will result in behavior that is a superset of trim. Whitespace at the beginning and end of text nodes will be trimmed. In addition, blank space (/s) between other text data will be converted to a single space (" "). Corresponds to the normalize option in node-xmlj2.

(false by default)

pub fn lowercase_tags(&mut self, flag: bool) -> &mut JsonConfig

Normalize all tags by converting them to lowercase.

Corresponds to the normalizeTags option in node-xml2js.

(false by default)

pub fn explicit_array(&mut self, flag: bool) -> &mut JsonConfig

Always put the child nodes in an array, otherwise an array is only created if there is more than one child.

(true by default)

pub fn explicit_charkey(&mut self, flag: bool) -> &mut JsonConfig

Always store character data under charkey even if there are are no other text elements stored inside the tag.

(false by default)

pub fn finalize(&self) -> JsonBuilder

Finalize configuration options and build a JsonBuilder instance

Trait Implementations

impl Default for JsonConfig

fn default() -> JsonConfig

Returns the “default value” for a type.