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

This is a push parser for lists.

== Synopsis

Declared in `<balxml_listparser.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
class ListParser;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/ListParser/ParseElementCallback.adoc[`ParseElementCallback`] 
| Callable type for parsing a single list element.
| xref:BloombergLP/balxml/ListParser/ParseElementFunction.adoc[`ParseElementFunction`] 
| Function‐pointer type for parsing a single list element.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/ListParser/2constructor.adoc[`ListParser`]         [.small]#[constructor]#
| Create a parser for lists using the specified `parseElementCallback` functor to parse each element and the optionally specified `basicAllocator` for supplying memory. If `basicAllocator` is 0, the currently installed default allocator will be used.
| xref:BloombergLP/balxml/ListParser/beginParse.adoc[`beginParse`] 
| Prepare the parser to start parsing a new value and associate the specified `object` with the parser. Return 0 if successful and non‐zero otherwise.
| xref:BloombergLP/balxml/ListParser/endParse.adoc[`endParse`] 
| Ends the parse operation and store the value parsed from the pushed characters into the associated object. Return 0 if successful and non‐zero otherwise. The behavior is undefined unless an object is associated with this parser. Upon successful completion, the parser will be disassociated with the object.
| xref:BloombergLP/balxml/ListParser/pushCharacters.adoc[`pushCharacters`] 
| Push the characters ranging from the specified `begin` up to (but not including) the specified `end` into this parser. Return 0 if successful and non‐zero otherwise. The parameterized `INPUT_ITERATOR` must be dereferenceable to a `char` value. The behavior is undefined unless an object is associated with this parser.
|===



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