[#BloombergLP-balxml-MiniReader]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::MiniReader
:relfileprefix: ../../
:mrdocs:

This `class` provides a concrete and efficient implementation of the `Reader` protocol.

== Synopsis

Declared in `<balxml_minireader.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class MiniReader
    : public xref:BloombergLP/balxml/Reader.adoc[Reader]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balxml/Reader.adoc[Reader]`
| This abstract class defines an interface for fast, forward‐only access to XML data.
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Reader/StreamBufPtr.adoc[`StreamBufPtr`] 
| Managed pointer to a `bsl::streambuf` used for external entity input.
| xref:BloombergLP/balxml/Reader/XmlResolverFunctor.adoc[`XmlResolverFunctor`] 
| Type for a user‐supplied functor that opens an external XML resource.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Reader/NodeType-02.adoc[`NodeType`] 
| Node types returned by `nodeType`, representing XML syntactic constructs within a document. Not every `Reader` implementation distinguishes all node types.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/MiniReader/2constructor-0f.adoc[`MiniReader`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/MiniReader/2destructor.adoc[`~MiniReader`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this reader and release resources.
| xref:BloombergLP/balxml/MiniReader/advanceToEndNode.adoc[`advanceToEndNode`]  [.small]#[virtual]#
| Skip all sub‐elements and position the reader on the corresponding end node.
| xref:BloombergLP/balxml/MiniReader/advanceToEndNodeRaw.adoc[`advanceToEndNodeRaw`]  [.small]#[virtual]#
| Skip all sub‐elements to the end node without well‐formedness checks.
| xref:BloombergLP/balxml/MiniReader/advanceToEndNodeRawBare.adoc[`advanceToEndNodeRawBare`]  [.small]#[virtual]#
| Skip all sub‐elements to the end node, allowing only bare XML.
| xref:BloombergLP/balxml/MiniReader/advanceToNextNode.adoc[`advanceToNextNode`]  [.small]#[virtual]#
| Move to the next node in the data stream created by `open`.
| xref:BloombergLP/balxml/MiniReader/close.adoc[`close`]  [.small]#[virtual]#
| Close the reader.
| xref:BloombergLP/balxml/MiniReader/documentEncoding.adoc[`documentEncoding`]  [.small]#[virtual]#
| Return the document encoding or NULL on error.
| xref:BloombergLP/balxml/Reader/dumpNode.adoc[`dumpNode`] 
| Print the information about the current node to the specified output `os` stream.
| xref:BloombergLP/balxml/MiniReader/errorInfo.adoc[`errorInfo`]  [.small]#[virtual]#
| Return a reference to the non‐modifiable error information for this reader. The returned value becomes invalid when `close` is called or the reader is destroyed.
| xref:BloombergLP/balxml/MiniReader/getColumnNumber.adoc[`getColumnNumber`]  [.small]#[virtual]#
| Return the current column number within the input stream.
| xref:BloombergLP/balxml/MiniReader/getCurrentPosition.adoc[`getCurrentPosition`] 
| Return the current scanner position as offset from the beginning of document.
| xref:BloombergLP/balxml/MiniReader/getLineNumber.adoc[`getLineNumber`]  [.small]#[virtual]#
| Return the current line number within the input stream.
| xref:BloombergLP/balxml/MiniReader/isEmptyElement.adoc[`isEmptyElement`]  [.small]#[virtual]#
| Return true if the current node is an empty element.
| xref:BloombergLP/balxml/Reader/isError.adoc[`isError`] 
| Return `true` if the derived object encountered a error. This method is equivalent to a call to `errorInfo().isError();`
| xref:BloombergLP/balxml/Reader/isFatalError.adoc[`isFatalError`] 
| Return `true` if the derived object encountered a fatal error. This method is equivalent to a call to `errorInfo().isFatalError();`
| xref:BloombergLP/balxml/MiniReader/isOpen.adoc[`isOpen`]  [.small]#[virtual]#
| Return true if `open` was called successfully and `close` has not yet been called and false otherwise.
| xref:BloombergLP/balxml/Reader/isWarning.adoc[`isWarning`] 
| Return `true` if the derived object encountered a warning. This method is equivalent to a call to `errorInfo().isWarning();`
| xref:BloombergLP/balxml/MiniReader/lookupAttribute-00.adoc[`lookupAttribute`] 
| `lookupAttribute` overloads
| xref:BloombergLP/balxml/MiniReader/nodeBaseUri.adoc[`nodeBaseUri`]  [.small]#[virtual]#
| Return the base URI of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeDepth.adoc[`nodeDepth`]  [.small]#[virtual]#
| Return the nesting depth of the current node in the XML document. The root node has depth 0.
| xref:BloombergLP/balxml/MiniReader/nodeEndPosition.adoc[`nodeEndPosition`] 
| Return the byte position within the document corresponding to the byte following after the last byte of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeHasValue.adoc[`nodeHasValue`]  [.small]#[virtual]#
| Return true if the current node has a value and false otherwise.
| xref:BloombergLP/balxml/MiniReader/nodeLocalName.adoc[`nodeLocalName`]  [.small]#[virtual]#
| Return the local name of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeName.adoc[`nodeName`]  [.small]#[virtual]#
| Return the qualified name of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeNamespaceId.adoc[`nodeNamespaceId`]  [.small]#[virtual]#
| Return the namespace ID of the current node if the current node has a namespace id and a negative number otherwise.
| xref:BloombergLP/balxml/MiniReader/nodeNamespaceUri.adoc[`nodeNamespaceUri`]  [.small]#[virtual]#
| Return the namespace URI of the current node.
| xref:BloombergLP/balxml/MiniReader/nodePrefix.adoc[`nodePrefix`]  [.small]#[virtual]#
| Return the prefix name of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeStartPosition.adoc[`nodeStartPosition`] 
| Return the byte position within the document corresponding to the first byte of the current node.
| xref:BloombergLP/balxml/MiniReader/nodeType.adoc[`nodeType`]  [.small]#[virtual]#
| Return the node type of the current node if the reader `isOpen` and has not encounter an error and `Reader::NONE` otherwise.
| xref:BloombergLP/balxml/MiniReader/nodeValue.adoc[`nodeValue`]  [.small]#[virtual]#
| Return the value of the current node.
| xref:BloombergLP/balxml/MiniReader/numAttributes.adoc[`numAttributes`]  [.small]#[virtual]#
| Return the number of attributes for the current node if that node has attributes and 0 otherwise.
| xref:BloombergLP/balxml/MiniReader/open-04.adoc[`open`] 
| `open` overloads
| xref:BloombergLP/balxml/MiniReader/options.adoc[`options`]  [.small]#[virtual]#
| Return the option flags.
| xref:BloombergLP/balxml/MiniReader/prefixStack.adoc[`prefixStack`]  [.small]#[virtual]#
| Return a pointer to the modifiable prefix stack used by this reader.
| xref:BloombergLP/balxml/MiniReader/resolver.adoc[`resolver`]  [.small]#[virtual]#
| Return the external XML resource resolver.
| xref:BloombergLP/balxml/MiniReader/setOptions.adoc[`setOptions`]  [.small]#[virtual]#
| Set the options to the flags in the specified `flags`.
| xref:BloombergLP/balxml/MiniReader/setPrefixStack.adoc[`setPrefixStack`]  [.small]#[virtual]#
| Set the prefix stack to the stack at the specified `prefixes` address.
| xref:BloombergLP/balxml/MiniReader/setResolver.adoc[`setResolver`]  [.small]#[virtual]#
| Set the external XML resource resolver to the specified `resolver`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Reader/nodeTypeAsString.adoc[`nodeTypeAsString`] 
| Return a string representation for the specified `nodeType` code or "(* UNKNOWN NODE TYPE *)" if nodeType is not one of the values enumerated in `NodeType`.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `BloombergLP::balxml::MiniReader::Node`
| 
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#