[#util-LineReader]
= xref:util.adoc[util]::LineReader
:relfileprefix: ../
:mrdocs:

Reads a character buffer line by line or in fixed‐length chunks.

== Synopsis

Declared in `<util/string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class LineReader;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/LineReader/2constructor.adoc[`LineReader`]         [.small]#[constructor]#
| Construct a reader over str that limits lines to max_line_length bytes.
| xref:util/LineReader/Consumed.adoc[`Consumed`] 
| Returns number of bytes already read from buffer
| xref:util/LineReader/ReadLength.adoc[`ReadLength`] 
| Returns string from current iterator position of specified length if possible and advances iterator on success. May exceed max_line_length but will not read past end of buffer.
| xref:util/LineReader/ReadLine.adoc[`ReadLine`] 
| Returns a string from current iterator position up to (but not including) next and advances iterator to the character following the on success. Will not return a line longer than max_line_length.
| xref:util/LineReader/Remaining.adoc[`Remaining`] 
| Returns remaining size of bytes in buffer
|===



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