VLink  2.0.0
A high-performance communication middleware
vlink::format::FormatToNResult< OutputItT > Struct Template Reference

Return type of format_to_n; carries the end iterator, total size and truncation flag. More...

#include <format.h>

Collaboration diagram for vlink::format::FormatToNResult< OutputItT >:

Public Attributes

OutputItT out
 Iterator one past the last written character. More...
 
size_t size {0}
 Total characters that the format would have written. More...
 
bool truncated {false}
 true when the output was truncated because size > n. More...
 

Detailed Description

template<typename OutputItT>
struct vlink::format::FormatToNResult< OutputItT >

Return type of format_to_n; carries the end iterator, total size and truncation flag.

Template Parameters
OutputItTIterator or pointer type used for output.

Member Data Documentation

◆ out

template<typename OutputItT >
OutputItT vlink::format::FormatToNResult< OutputItT >::out

Iterator one past the last written character.

◆ size

template<typename OutputItT >
size_t vlink::format::FormatToNResult< OutputItT >::size {0}

Total characters that the format would have written.

◆ truncated

template<typename OutputItT >
bool vlink::format::FormatToNResult< OutputItT >::truncated {false}

true when the output was truncated because size > n.


The documentation for this struct was generated from the following file: