Dune Core Modules (unstable)

Dune::Base64Stream Class Reference

class to base64 encode a stream of data More...

#include <dune/grid/io/file/vtk/streams.hh>

Public Member Functions

 Base64Stream (std::ostream &s_)
 Construct a Base64Stream. More...
 
template<class X >
void write (X &data)
 encode a data item More...
 
void flush ()
 flush the current unwritten data to the stream. More...
 
 ~Base64Stream ()
 destroy the object More...
 

Detailed Description

class to base64 encode a stream of data

Constructor & Destructor Documentation

◆ Base64Stream()

Dune::Base64Stream::Base64Stream ( std::ostream &  s_)
inline

Construct a Base64Stream.

Parameters
s_The stream the resulting base64-encoded text will be written to.

◆ ~Base64Stream()

Dune::Base64Stream::~Base64Stream ( )
inline

destroy the object

Calls flush()

References flush().

Member Function Documentation

◆ flush()

void Dune::Base64Stream::flush ( )
inline

flush the current unwritten data to the stream.

If the size of the received input is not a multiple of three bytes, an end-marker will be written.

Calling this function a second time without calling b64enc() or calling it right after construction has no effect.

Referenced by Dune::VTK::BinaryDataArrayWriter::BinaryDataArrayWriter(), Dune::VTK::NakedBase64DataArrayWriter::NakedBase64DataArrayWriter(), ~Base64Stream(), and Dune::VTK::BinaryDataArrayWriter::~BinaryDataArrayWriter().

◆ write()

template<class X >
void Dune::Base64Stream::write ( X &  data)
inline

encode a data item

The result will be written to the stream, eventually. This method may be called multiple times in a row. After this method has been called, no one else may write to the underlying stream until flush() has been called or this writer object has been destroyed.

Referenced by Dune::VTK::BinaryDataArrayWriter::BinaryDataArrayWriter(), and Dune::VTK::NakedBase64DataArrayWriter::NakedBase64DataArrayWriter().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)