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

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.

== Synopsis

Declared in `<util/string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional<std::string_view>
ReadLine();
----

== Exceptions

[cols="1,4"]
|===
| Name| Thrown on
| `std::runtime_error`
| if max_line_length + 1 bytes are read without finding .
|===

== Return Value

the next string from the buffer. std::nullopt if end of buffer is reached without finding a .


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