Struct ipworks::XML

Properties   Methods   Events   Config Settings   Errors  

The XML struct can be used to both parse and create XML documents.

Syntax

ipworks::XML

Remarks

The XML struct can operate as either a parser or writer of XML.

Parsing XML

The XML struct parses XML documents and verifies that they are well formed. The results are provided through a set of events complying with the SAX2 specification.

In addition, the document structure may be queried through an xpath mechanism that supports a subset of the XPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal Document Object Model (DOM) structures with close to zero heap allocations. Additionally, build_dom can be set to false, which reduces the overhead of creating the DOM and offers a fast, forward-only parsing implementation that fires events to provide the parsed data.

When parsing a document, events will fire to provide information about the parsed data. After parse returns, the document may be navigated by setting xpath if build_dom is true (default). If build_dom is false, parsed data are accessible only through the events.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• on_characters
• on_comment
• on_end_element
• on_end_prefix_mapping
• on_eval_entity
• on_ignorable_whitespace
• on_meta
• on_pi
• on_special_section
• on_start_element
• on_start_prefix_mapping

If build_dom is true (default), xpath may be set after this method returns. xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document.

The path is a series of one or more element accessors separated by /. The path can be absolute (starting with /) or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to true before parsing the document for the xpath functionality to be available.

Example. Setting XPath:

Input Properties

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

If parsing multiple documents, call reset between documents to reset the parser.

An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g., HTML). This is enabled by setting validate to false. In this case, events will be fired as elements, entities, and so on are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.

Writing XML

To use the struct, first decide whether or not to write to a file or output_data.

Output Properties

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• output_file
• output_data: The output data are written to this property if no other destination is specified.

To begin writing the XML document, first optionally set xml_declaration. If this is not set, the struct will use a default XML declaration at the beginning of the document.

Next, begin adding elements to your document. Calling start_element will open an element with the specified name. To create a nested structure, continue calling start_element to open more child elements. To write a value within an element, call put_string. To close the element that was last opened, call end_element. Each time end_element is called, the element at the current level is closed. Alternatively, calling put_element will write the element with the value specified and will also close the element.

To write an attribute of the current element, call put_attr after calling start_element. Call put_attr multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the put_comment and put_c_data methods.

To close your XML document, call save. You can call save from any location, and it will close any remaining open elements automatically.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the XML struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of XML when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

build_dom property (XML Struct)

When set to true, this property creates an internal object model of the XML document.

Syntax

fn build_dom(&self ) -> Result<bool, IPWorksError> 
fn set_build_dom(&self, value : bool) ->  Option<IPWorksError> 

Default Value

true

Remarks

Set build_dom to true when you need to browse the current document through xpath.

validate is automatically set to true when build_dom is set to true.

Data Type

bool

input_data property (XML Struct)

This property specifies the XML data to parse.

Syntax

fn input_data(&self ) -> Result<String, IPWorksError> 
fn set_input_data(&self, value : &str) ->  Option<IPWorksError> 
fn set_input_data_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the XML to be processed. Set this property before calling parse.

This property may be set to a complete XML document or to partial data. When setting partial data, call parse after each chunk of data is set. For instance:

//Parse the following in chunks: <test>1</test> xml.InputData = "<test>" xml.Parse(); xml.InputData = "1<test>" xml.Parse();

Input Properties

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

Data Type

String

input_file property (XML Struct)

This property specifies the file to process.

Syntax

fn input_file(&self ) -> Result<String, IPWorksError> 
fn set_input_file(&self, value : &str) ->  Option<IPWorksError> 
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.

After setting this property, call parse to parse the document.

Input Properties

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

Data Type

String

namespace_count property (XML Struct)

The number of records in the Namespace arrays.

Syntax

fn namespace_count(&self ) -> Result<i32, IPWorksError> 
fn set_namespace_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• namespace_prefix
• namespace_uri

The array indices start at 0 and end at namespace_count - 1.

Data Type

i32

namespace_prefix property (XML Struct)

This property contains the Prefix for the namespace.

Syntax

fn namespace_prefix(&self , NamespaceIndex : i32) -> Result<String, IPWorksError> 
fn set_namespace_prefix(&self, NamespaceIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_namespace_prefix_ref(&self, NamespaceIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the namespace_prefix for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

Data Type

String

namespace_uri property (XML Struct)

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

fn namespace_uri(&self , NamespaceIndex : i32) -> Result<String, IPWorksError> 
fn set_namespace_uri(&self, NamespaceIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_namespace_uri_ref(&self, NamespaceIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding namespace_prefix. This URL is usually pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

Data Type

String

output_data property (XML Struct)

The output XML after processing.

Syntax

fn output_data(&self ) -> Result<String, IPWorksError> 
fn set_output_data(&self, value : &str) ->  Option<IPWorksError> 
fn set_output_data_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property will be populated with the output from the operation if output_file is not set.

Data Type

String

output_file property (XML Struct)

This property includes the path to a local file where the output will be written.

Syntax

fn output_file(&self ) -> Result<String, IPWorksError> 
fn set_output_file(&self, value : &str) ->  Option<IPWorksError> 
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Output Properties

The struct will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• output_file
• output_data: The output data are written to this property if no other destination is specified.

Data Type

String

overwrite property (XML Struct)

This property indicates whether or not the struct should overwrite files.

Syntax

fn overwrite(&self ) -> Result<bool, IPWorksError> 
fn set_overwrite(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

This property indicates whether or not the struct will overwrite output_file. If overwrite is false, an error will be thrown whenever output_file exists before an operation. The default value is false.

Data Type

bool

validate property (XML Struct)

This property controls whether documents are validated during parsing.

Syntax

fn validate(&self ) -> Result<bool, IPWorksError> 
fn set_validate(&self, value : bool) ->  Option<IPWorksError> 

Default Value

true

Remarks

When true (default), the document will be validated during parsing. To disable validation set validate to false. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed.

Data Type

bool

attr_count property (XML Struct)

The number of records in the Attr arrays.

Syntax

fn attr_count(&self ) -> Result<i32, IPWorksError> 
fn set_attr_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attr_name
• attr_namespace
• attr_prefix
• attr_value

The array indices start at 0 and end at attr_count - 1.

Data Type

i32

attr_name property (XML Struct)

The Name provides the local name (without prefix) of the attribute.

Syntax

fn attr_name(&self , AttrIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The attr_name provides the local name (without prefix) of the attribute.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only.

Data Type

String

attr_namespace property (XML Struct)

This property contains the attribute namespace.

Syntax

fn attr_namespace(&self , AttrIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the attribute namespace.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only.

Data Type

String

attr_prefix property (XML Struct)

This property contains the attribute prefix (if any).

Syntax

fn attr_prefix(&self , AttrIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only.

Data Type

String

attr_value property (XML Struct)

This property contains the attribute value.

Syntax

fn attr_value(&self , AttrIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only.

Data Type

String

xchild_count property (XML Struct)

The number of records in the XChild arrays.

Syntax

fn xchild_count(&self ) -> Result<i32, IPWorksError> 
fn set_xchild_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• xchild_name
• xchild_namespace
• xchild_prefix
• xchild_x_text

The array indices start at 0 and end at xchild_count - 1.

Data Type

i32

xchild_name property (XML Struct)

The Name property provides the local name (without a prefix) of the element.

Syntax

fn xchild_name(&self , XChildIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The xchild_name property provides the local name (without a prefix) of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only.

Data Type

String

xchild_namespace property (XML Struct)

This property contains the namespace of the element.

Syntax

fn xchild_namespace(&self , XChildIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only.

Data Type

String

xchild_prefix property (XML Struct)

This property contains the prefix of the element (if any).

Syntax

fn xchild_prefix(&self , XChildIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only.

Data Type

String

xchild_x_text property (XML Struct)

This property contains the inner text of the element.

Syntax

fn xchild_x_text(&self , XChildIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property contains the inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only.

Data Type

String

xcomment_count property (XML Struct)

The number of records in the XComment arrays.

Syntax

fn xcomment_count(&self ) -> Result<i32, IPWorksError> 
fn set_xcomment_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• xcomment_text

The array indices start at 0 and end at xcomment_count - 1.

Data Type

i32

xcomment_text property (XML Struct)

This property holds the comment text.

Syntax

fn xcomment_text(&self , XCommentIndex : i32) -> Result<String, IPWorksError> 
fn set_xcomment_text(&self, XCommentIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_xcomment_text_ref(&self, XCommentIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property holds the comment text.

The XCommentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XCommentCount property.

Data Type

String

xelement property (XML Struct)

This property includes the name of the current element.

Syntax

fn xelement(&self ) -> Result<String, IPWorksError> 
fn set_xelement(&self, value : &str) ->  Option<IPWorksError> 
fn set_xelement_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property.

Data Type

String

xml_declaration_encoding property (XML Struct)

This property specifies the XML encoding to use.

Syntax

fn xml_declaration_encoding(&self ) -> Result<String, IPWorksError> 
fn set_xml_declaration_encoding(&self, value : &str) ->  Option<IPWorksError> 
fn set_xml_declaration_encoding_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

"utf-8"

Remarks

This property specifies the XML encoding to use.

This may be set before writing a document. The default value is UTF-8.

This is applicable only when writing XML.

Data Type

String

xml_declaration_standalone property (XML Struct)

This property indicates whether the standalone attribute is present in the declaration with a value of True .

Syntax

fn xml_declaration_standalone(&self ) -> Result<bool, IPWorksError> 
fn set_xml_declaration_standalone(&self, value : bool) ->  Option<IPWorksError> 

Default Value

true

Remarks

This property indicates whether the standalone attribute is present in the declaration with a value of true.

This may be set before writing a document. The default value is true.

This is applicable only when writing XML.

Data Type

bool

xml_declaration_version property (XML Struct)

This property specifies the XML version.

Syntax

fn xml_declaration_version(&self ) -> Result<String, IPWorksError> 
fn set_xml_declaration_version(&self, value : &str) ->  Option<IPWorksError> 
fn set_xml_declaration_version_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

"1.0"

Remarks

This property specifies the XML version.

This may be set before writing a document. The default value is 1.0.

This is applicable only when writing XML.

Data Type

String

xnamespace property (XML Struct)

This property includes the namespace of the current element.

Syntax

fn xnamespace(&self ) -> Result<String, IPWorksError> 
fn set_xnamespace(&self, value : &str) ->  Option<IPWorksError> 
fn set_xnamespace_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property.

Data Type

String

xparent property (XML Struct)

This property includes the parent of the current element.

Syntax

fn xparent(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property.

This property is read-only.

Data Type

String

xpath property (XML Struct)

This property provides a way to point to a specific element in the document.

Syntax

fn xpath(&self ) -> Result<String, IPWorksError> 
fn set_xpath(&self, value : &str) ->  Option<IPWorksError> 
fn set_xpath_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document.

The path is a series of one or more element accessors separated by /. The path can be absolute (starting with /) or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to true before parsing the document for the xpath functionality to be available.

Example. Setting XPath:

Data Type

String

xprefix property (XML Struct)

This property includes the prefix of the current element.

Syntax

fn xprefix(&self ) -> Result<String, IPWorksError> 
fn set_xprefix(&self, value : &str) ->  Option<IPWorksError> 
fn set_xprefix_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property.

Data Type

String

xsub_tree property (XML Struct)

This property includes a snapshot of the current element in the document.

Syntax

fn xsub_tree(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property. For this property to work, you must set CacheContent to true.

This property is read-only.

Data Type

String

xtext property (XML Struct)

This property includes the text of the current element.

Syntax

fn xtext(&self ) -> Result<String, IPWorksError> 
fn set_xtext(&self, value : &str) ->  Option<IPWorksError> 
fn set_xtext_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The current element is specified through the xpath property.

The XText property can be used to update or change the content of the selected element.

Example. Updating an element via XText: xml.InputData = "<person><name>John</name></person>"; xml.Parse(); xml.XPath = "/person/name"; xml.XText; // John xml.XText = "Mary"; xml.Save();

Data Type

String

config method (XML Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

end_element method (XML Struct)

This method writes the closing tag of an open XML element.

Syntax

fn end_element(&self) -> Result<(), IPWorksError>

Remarks

This method writes the closing tag of the XML element most recently opened using start_element.

If no elements are opened, the call fails with an error.

flush method (XML Struct)

This method flushes the parser and checks its end state.

Syntax

fn flush(&self) -> Result<(), IPWorksError>

Remarks

When flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If validate is true, the parser verifies that all open elements were closed, returning an error if not.

get_attr method (XML Struct)

This method returns the value of the specified attribute.

Syntax

fn get_attr(&self, attr_name : &str) ->  Result<String, IPWorksError>

Remarks

This method returns the value of the attribute specified by the attr_name parameter.

If the attribute does not exist, an empty string is returned. The behavior when an attribute does not exist is controlled by ErrorOnEmptyAttr.

Please refer to the attr_name, attr_namespace, attr_prefix, and attr_value properties for more information.

has_xpath method (XML Struct)

This method determines whether a specific element exists in the document.

Syntax

fn has_xpath(&self, xpath : &str) ->  Result<bool, IPWorksError>

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through xpath.

This method returns true if the xpath exists, and false if not.

See xpath for details on the XPath syntax.

insert_attr method (XML Struct)

This method inserts a new attribute into the current element.

Syntax

fn insert_attr(&self, name : &str, namespace_uri : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method inserts a new attribute into the element at the current xpath.

This method requires that build_dom is set to true. If the attribute specified by name already exists in the current element, an error is returned. To update an existing attribute, use set_attr.

To write attributes when building a new document from scratch, use put_attr.

insert_element method (XML Struct)

This method inserts a new child element into the current element.

Syntax

fn insert_element(&self, name : &str, namespace_uri : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method appends a new child element into the element at the current xpath.

This method requires that build_dom is set to true. Multiple child elements with the same name may be added.

To write elements when building a new document from scratch, use put_element.

interrupt method (XML Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

load_dom method (XML Struct)

This method loads the document object model (DOM) from a file.

Syntax

fn load_dom(&self, file_name : &str) -> Result<(), IPWorksError>

Remarks

The load_dom method loads a DOM structure previously saved by save_dom from the file specified in file_name.

Please refer to the save_dom method for more information.

load_schema method (XML Struct)

This method loads the XML schema.

Syntax

fn load_schema(&self, schema : &str) -> Result<(), IPWorksError>

Remarks

This functionality is not yet implemented.

This method loads the schema specified in the schema parameter. The schema may be specified as either a string or the path to a file on disk.

The struct will validate the input data during parsing to verify whether or not it adheres to the schema.

parse method (XML Struct)

This method parses the specified XML data.

Syntax

fn parse(&self) -> Result<(), IPWorksError>

Remarks

This method parses the specified XML data.

When parsing a document, events will fire to provide information about the parsed data. After parse returns, the document may be navigated by setting xpath if build_dom is true (default). If build_dom is false, parsed data are accessible only through the events.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• on_characters
• on_comment
• on_end_element
• on_end_prefix_mapping
• on_eval_entity
• on_ignorable_whitespace
• on_meta
• on_pi
• on_special_section
• on_start_element
• on_start_prefix_mapping

If build_dom is true (default), xpath may be set after this method returns. xpath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document.

The path is a series of one or more element accessors separated by /. The path can be absolute (starting with /) or relative to the current xpath location.

The following are possible values for an element accessor:

build_dom must be set to true before parsing the document for the xpath functionality to be available.

Example. Setting XPath:

Input Properties

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• input_file
• input_data

If parsing multiple documents, call reset between documents to reset the parser.

put_attr method (XML Struct)

This method writes an XML attribute.

Syntax

fn put_attr(&self, name : &str, namespace_uri : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method writes an XML attribute in the currently opened XML element. It must be called right after calling start_element and before any calls to put_string, put_comment, or put_raw.

If name is a local name without a prefix, the struct will automatically introduce a new xmlns="namespace_uri" attribute, if necessary.

If name is in the form prefix:local, the struct will automatically introduce a new xmlns:prefix="namespace_uri" as necessary.

Certain attribute names will be handled in special ways by this method. If name is xmlns or uses the xmlns prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of namespace_uri. Similarly, any attribute using the xml prefix will be interpreted as a special attribute (like xml:lang) and namespace_uri will be ignored.

To add or modify attributes in an existing parsed document, use insert_attr or set_attr.

put_c_data method (XML Struct)

This method writes an XML CDATA block.

Syntax

fn put_c_data(&self, text : &str) -> Result<(), IPWorksError>

Remarks

This method writes a new XML CDATA block with the specified text inside the current element.

put_comment method (XML Struct)

This method writes an XML comment block.

Syntax

fn put_comment(&self, text : &str) -> Result<(), IPWorksError>

Remarks

This method writes a new XML comment block with the specified text.

put_element method (XML Struct)

This method writes a simple XML element with a value.

Syntax

fn put_element(&self, name : &str, namespace_uri : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method writes a simple XML element with no attributes and the specified value between the opening and closing tags. To add elements to an existing parsed document, use insert_element.

If name is a local name without a prefix, the struct will automatically introduce a new xmlns="namespace_uri" attribute, if necessary.

If name is in the form prefix:local, the struct will automatically introduce a new xmlns:prefix="namespace_uri" as necessary.

When calling put_element or start_element, if a namespace_uri is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a namespace_uri value must be provided. When creating the XML, the struct will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

put_raw method (XML Struct)

This method writes a raw XML fragment.

Syntax

fn put_raw(&self, text : &str) -> Result<(), IPWorksError>

Remarks

This method writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written before the raw fragment, the fragment will be written as a child of the current element.

Use of this method should be carefully considered as it can easily lead to malformed XML content.

put_string method (XML Struct)

This method writes text inside an XML element.

Syntax

fn put_string(&self, text : &str) -> Result<(), IPWorksError>

Remarks

This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element.

remove_attr method (XML Struct)

This method removes an attribute from the current element.

Syntax

fn remove_attr(&self, attr_name : &str) -> Result<(), IPWorksError>

Remarks

This method removes the attribute specified by attr_name from the element at the current xpath. This method requires that build_dom is set to true. If the specified attribute does not exist in the current element, the method returns without error.

This functionality is not yet implemented.

remove_children method (XML Struct)

This method removes the children of the element at the specified XPath.

Syntax

fn remove_children(&self) -> Result<(), IPWorksError>

Remarks

This method removes the children of the element specified by xpath. This method requires that build_dom is set to true.

When called, the struct will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after parse returns, or from within the on_end_element event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveChildren:

Given the XML:

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the children of the apple element while leaving the apple element in place.

xml.XPath = "/food/fruits/apple"; xml.RemoveChildren();

The XML stored in the DOM is now:

<food>
	<fruits>
		<apple>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

remove_element method (XML Struct)

This method removes the element at the specified XPath.

Syntax

fn remove_element(&self) -> Result<(), IPWorksError>

Remarks

This method removes the element specified by xpath. This method requires that build_dom is set to true.

When called, the struct will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after parse returns, or from within the on_end_element event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveElement:

Given the XML:

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple"; xml.RemoveElement();

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

reset method (XML Struct)

This method resets the parser.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

reset must also be used as a signal to the parser that the current stream of text has terminated.

save method (XML Struct)

This method saves the current XML output.

Syntax

fn save(&self) -> Result<(), IPWorksError>

Remarks

When used with the streaming writer (e.g., after start_element and end_element calls), this method closes any open XML elements and then closes the output_file if necessary.

When used after parsing and modifying a document via the DOM (e.g., after insert_attr, insert_element, set_attr, remove_attr, remove_element, or remove_children), this method serializes the modified DOM to output_file .

save_dom method (XML Struct)

This method saves the DOM to a file.

Syntax

fn save_dom(&self, file_name : &str) -> Result<(), IPWorksError>

Remarks

The save_dom method saves the current DOM structure to the file specified in file_name. This enables the struct to later load the DOM without incurring any parsing overhead.

Please refer to the load_dom method for more information.

set_attr method (XML Struct)

This method sets the value of an existing attribute in the current element.

Syntax

fn set_attr(&self, name : &str, namespace_uri : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method updates the value of an attribute in the element at the current xpath.

This method requires that build_dom is set to true. If the attribute specified by name does not already exist in the current element, an error is returned. To add a new attribute, use insert_attr.

start_element method (XML Struct)

This method writes the opening tag of an XML element.

Syntax

fn start_element(&self, name : &str, namespace_uri : &str) -> Result<(), IPWorksError>

Remarks

This method writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child.

If name is a local name without a prefix, the struct will automatically introduce a new xmlns="namespace_uri" attribute, if necessary.

If name is in the form prefix:local, the struct will automatically introduce a new xmlns:prefix="namespace_uri" as necessary.

When calling put_element or start_element, if a namespace_uri is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a namespace_uri value must be provided. When creating the XML, the struct will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

try_xpath method (XML Struct)

This method navigates to the specified XPath if it exists.

Syntax

fn try_xpath(&self, xpath : &str) ->  Result<bool, IPWorksError>

Remarks

This method will attempt to navigate to the specified xpath parameter if it exists within the document.

If the XPath exists, the xpath property will be updated and this method returns true.

If the XPath does not exist, the xpath property is not updated and this method returns false.

on_characters event (XML Struct)

This event is fired for plaintext segments of the input stream.

Syntax

// XMLCharactersEventArgs carries the XML Characters event's parameters.
pub struct XMLCharactersEventArgs {
  fn text(&self) -> &String
}

// XMLCharactersEvent defines the signature of the XML Characters event's handler function.
pub trait XMLCharactersEvent {
  fn on_characters(&self, sender : XML, e : &mut XMLCharactersEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_characters(&self) -> &'a dyn XMLCharactersEvent;
  pub fn set_on_characters(&mut self, value : &'a dyn XMLCharactersEvent);
  ...
}

Remarks

The on_characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the text parameter.

The text includes whitespace as well as end-of-line characters, except for ignorable whitespace, which is fired through the on_ignorable_whitespace event.

on_comment event (XML Struct)

This event is fired when a comment section is encountered.

Syntax

// XMLCommentEventArgs carries the XML Comment event's parameters.
pub struct XMLCommentEventArgs {
  fn text(&self) -> &String
}

// XMLCommentEvent defines the signature of the XML Comment event's handler function.
pub trait XMLCommentEvent {
  fn on_comment(&self, sender : XML, e : &mut XMLCommentEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_comment(&self) -> &'a dyn XMLCommentEvent;
  pub fn set_on_comment(&mut self, value : &'a dyn XMLCommentEvent);
  ...
}

Remarks

The on_comment event is fired whenever a comment section (<!-- ...text... -->) is found in the document.

The full text of the comment is provided by the text parameter.

on_end_element event (XML Struct)

This event is fired when an end-element tag is encountered.

Syntax

// XMLEndElementEventArgs carries the XML EndElement event's parameters.
pub struct XMLEndElementEventArgs {
  fn namespace(&self) -> &String
  fn element(&self) -> &String
  fn q_name(&self) -> &String
  fn is_empty(&self) -> bool
}

// XMLEndElementEvent defines the signature of the XML EndElement event's handler function.
pub trait XMLEndElementEvent {
  fn on_end_element(&self, sender : XML, e : &mut XMLEndElementEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_end_element(&self) -> &'a dyn XMLEndElementEvent;
  pub fn set_on_end_element(&mut self, value : &'a dyn XMLEndElementEvent);
  ...
}

Remarks

The on_end_element event is fired when an end-element tag is found in the document.

The element name is provided by the element parameter.

The is_empty parameter is true when the event corresponds to an empty element declaration.

on_end_prefix_mapping event (XML Struct)

This event is fired when leaving the scope of a namespace declaration.

Syntax

// XMLEndPrefixMappingEventArgs carries the XML EndPrefixMapping event's parameters.
pub struct XMLEndPrefixMappingEventArgs {
  fn prefix(&self) -> &String
}

// XMLEndPrefixMappingEvent defines the signature of the XML EndPrefixMapping event's handler function.
pub trait XMLEndPrefixMappingEvent {
  fn on_end_prefix_mapping(&self, sender : XML, e : &mut XMLEndPrefixMappingEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_end_prefix_mapping(&self) -> &'a dyn XMLEndPrefixMappingEvent;
  pub fn set_on_end_prefix_mapping(&mut self, value : &'a dyn XMLEndPrefixMappingEvent);
  ...
}

Remarks

The on_start_prefix_mapping event is fired when entering the scope of a namespace declaration.

on_error event (XML Struct)

Fired when information is available about errors during data delivery.

Syntax

// XMLErrorEventArgs carries the XML Error event's parameters.
pub struct XMLErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// XMLErrorEvent defines the signature of the XML Error event's handler function.
pub trait XMLErrorEvent {
  fn on_error(&self, sender : XML, e : &mut XMLErrorEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_error(&self) -> &'a dyn XMLErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn XMLErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_eval_entity event (XML Struct)

This event is fired every time an entity needs to be evaluated.

Syntax

// XMLEvalEntityEventArgs carries the XML EvalEntity event's parameters.
pub struct XMLEvalEntityEventArgs {
  fn entity(&self) -> &String
  fn value(&self) -> &String
  fn set_value(&self, value : &str)
  fn set_value_ref(&self, value : &String)
}

// XMLEvalEntityEvent defines the signature of the XML EvalEntity event's handler function.
pub trait XMLEvalEntityEvent {
  fn on_eval_entity(&self, sender : XML, e : &mut XMLEvalEntityEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_eval_entity(&self) -> &'a dyn XMLEvalEntityEvent;
  pub fn set_on_eval_entity(&mut self, value : &'a dyn XMLEvalEntityEvent);
  ...
}

Remarks

The value parameter contains a suggested value for the entity (normally the entity name itself). You may set value to a value of your choice, which will later be passed into the text stream.

on_ignorable_whitespace event (XML Struct)

This event is fired when a section of ignorable whitespace is encountered.

Syntax

// XMLIgnorableWhitespaceEventArgs carries the XML IgnorableWhitespace event's parameters.
pub struct XMLIgnorableWhitespaceEventArgs {
  fn text(&self) -> &String
}

// XMLIgnorableWhitespaceEvent defines the signature of the XML IgnorableWhitespace event's handler function.
pub trait XMLIgnorableWhitespaceEvent {
  fn on_ignorable_whitespace(&self, sender : XML, e : &mut XMLIgnorableWhitespaceEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_ignorable_whitespace(&self) -> &'a dyn XMLIgnorableWhitespaceEvent;
  pub fn set_on_ignorable_whitespace(&mut self, value : &'a dyn XMLIgnorableWhitespaceEvent);
  ...
}

Remarks

The ignorable whitespace section is provided by the text parameter.

on_meta event (XML Struct)

This event fires when a meta section is encountered.

Syntax

// XMLMetaEventArgs carries the XML Meta event's parameters.
pub struct XMLMetaEventArgs {
  fn text(&self) -> &String
}

// XMLMetaEvent defines the signature of the XML Meta event's handler function.
pub trait XMLMetaEvent {
  fn on_meta(&self, sender : XML, e : &mut XMLMetaEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_meta(&self) -> &'a dyn XMLMetaEvent;
  pub fn set_on_meta(&mut self, value : &'a dyn XMLMetaEvent);
  ...
}

Remarks

The on_meta event is fired whenever a meta information section (<! ...text... >) is found in the document.

The full text of the meta section is provided by the text parameter.

on_pi event (XML Struct)

This event is fired when a processing instruction section is encountered.

Syntax

// XMLPIEventArgs carries the XML PI event's parameters.
pub struct XMLPIEventArgs {
  fn text(&self) -> &String
}

// XMLPIEvent defines the signature of the XML PI event's handler function.
pub trait XMLPIEvent {
  fn on_pi(&self, sender : XML, e : &mut XMLPIEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_pi(&self) -> &'a dyn XMLPIEvent;
  pub fn set_on_pi(&mut self, value : &'a dyn XMLPIEvent);
  ...
}

Remarks

The on_pi event is fired whenever a processing instruction section (<? ...text... ?>) is found in the document.

The full text of the processing instruction is provided by the text parameter.

on_special_section event (XML Struct)

This event is fired when a special section is encountered.

Syntax

// XMLSpecialSectionEventArgs carries the XML SpecialSection event's parameters.
pub struct XMLSpecialSectionEventArgs {
  fn section_id(&self) -> &String
  fn text(&self) -> &String
}

// XMLSpecialSectionEvent defines the signature of the XML SpecialSection event's handler function.
pub trait XMLSpecialSectionEvent {
  fn on_special_section(&self, sender : XML, e : &mut XMLSpecialSectionEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_special_section(&self) -> &'a dyn XMLSpecialSectionEvent;
  pub fn set_on_special_section(&mut self, value : &'a dyn XMLSpecialSectionEvent);
  ...
}

Remarks

The on_special_section event is fired whenever a special section (such as <![ CDATA [ ...text... ]]>) is found in the document.

The full text of the special section is provided by the text parameter, and the section_id parameter provides the section identifier (e.g., CDATA).

on_start_element event (XML Struct)

This event is fired when a begin-element tag is encountered in the document.

Syntax

// XMLStartElementEventArgs carries the XML StartElement event's parameters.
pub struct XMLStartElementEventArgs {
  fn namespace(&self) -> &String
  fn element(&self) -> &String
  fn q_name(&self) -> &String
  fn is_empty(&self) -> bool
}

// XMLStartElementEvent defines the signature of the XML StartElement event's handler function.
pub trait XMLStartElementEvent {
  fn on_start_element(&self, sender : XML, e : &mut XMLStartElementEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_start_element(&self) -> &'a dyn XMLStartElementEvent;
  pub fn set_on_start_element(&mut self, value : &'a dyn XMLStartElementEvent);
  ...
}

Remarks

The on_start_element event is fired when a begin-element tag is found in the document.

The element name is provided through the element parameter. The attribute names and values (if any) are provided through the attr_name, attr_namespace, attr_prefix, and attr_value properties.

The is_empty parameter is true when the event corresponds to an empty element declaration.

on_start_prefix_mapping event (XML Struct)

This event is fired when entering the scope of a namespace declaration.

Syntax

// XMLStartPrefixMappingEventArgs carries the XML StartPrefixMapping event's parameters.
pub struct XMLStartPrefixMappingEventArgs {
  fn prefix(&self) -> &String
  fn uri(&self) -> &String
}

// XMLStartPrefixMappingEvent defines the signature of the XML StartPrefixMapping event's handler function.
pub trait XMLStartPrefixMappingEvent {
  fn on_start_prefix_mapping(&self, sender : XML, e : &mut XMLStartPrefixMappingEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_start_prefix_mapping(&self) -> &'a dyn XMLStartPrefixMappingEvent;
  pub fn set_on_start_prefix_mapping(&mut self, value : &'a dyn XMLStartPrefixMappingEvent);
  ...
}

Remarks

The on_end_prefix_mapping event is fired when leaving the scope of a namespace declaration.

on_xml event (XML Struct)

This event is fired as XML is written.

Syntax

// XMLXMLEventArgs carries the XML XML event's parameters.
pub struct XMLXMLEventArgs {
  fn text(&self) -> &String
}

// XMLXMLEvent defines the signature of the XML XML event's handler function.
pub trait XMLXMLEvent {
  fn on_xml(&self, sender : XML, e : &mut XMLXMLEventArgs);
}

impl <'a> XML<'a> {
  pub fn on_xml(&self) -> &'a dyn XMLXMLEvent;
  pub fn set_on_xml(&mut self, value : &'a dyn XMLXMLEvent);
  ...
}

Remarks

This event is fired when XML is output. The text parameter holds the data being written.

This functionality is not yet implemented.

Config Settings (XML Struct)

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (XML Struct)

XML Errors