byteme::OstreamWriter< Pointer_ > Class Template Reference

Read bytes from a std::ostream. More...

#include <OstreamWriter.hpp>

Inheritance diagram for byteme::OstreamWriter< Pointer_ >:

Collaboration diagram for byteme::OstreamWriter< Pointer_ >:

Public Member Functions
	OstreamWriter (Pointer_ output)
void	write (const unsigned char *buffer, std::size_t n)
void	finish ()
Public Member Functions inherited from byteme::Writer
virtual	~Writer ()=default

Detailed Description

template<class Pointer_>
class byteme::OstreamWriter< Pointer_ >

Read bytes from a std::ostream.

Template Parameters

Stream_

Class providing an output stream of bytes, satisfying the std::ostream interface. This is most typically a std::unique_ptr<std::ostream> but a concrete subclass may also be used to encourage compiler devirtualization. Either a raw or smart pointer may be used depending on how the lifetime of the pointed-to object is managed.

This is just a wrapper around std::ostream::write for compatibility.

Constructor & Destructor Documentation

OstreamWriter()

template<class Pointer_ >

byteme::OstreamWriter< Pointer_ >::OstreamWriter ( Pointer_ output )

inline

Parameters

output

Pointer to an output stream.

Member Function Documentation

finish()

template<class Pointer_ >

void byteme::OstreamWriter< Pointer_ >::finish ( )

inlinevirtual

Indicate that the writing has finished and that the relevant clean-up (buffer flushing, file closing, etc.) should be performed. This should be called exactly once, after which no further calls to write() or finish() should be performed.

Implements byteme::Writer.

write()

template<class Pointer_ >

void byteme::OstreamWriter< Pointer_ >::write ( const unsigned char * buffer, std::size_t n )

inlinevirtual

Write the next chunk of bytes to the output sink. This may or may not be internally buffered at the discretion of the concrete class.

Parameters

[in]	buffer	Pointer to the start of an array containing the bytes to be written.
	n	Length of the array in buffer. This may be zero.

Implements byteme::Writer.

---

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

• byteme/OstreamWriter.hpp