c2pa-cpp v0.27.0
C++ API for the C2PA SDK
Loading...
Searching...
No Matches
c2pa::CppOStream Class Reference

Output stream OStream wrapper for C2paStream. More...

#include <c2pa.hpp>

Inheritance diagram for c2pa::CppOStream:
Collaboration diagram for c2pa::CppOStream:

Public Member Functions

template<typename OStream>
 CppOStream (OStream &ostream)
 Construct an output stream wrapper from a std::ostream-derived object.
 CppOStream (const CppOStream &)=delete
CppOStream & operator= (const CppOStream &)=delete
 CppOStream (CppOStream &&)=delete
CppOStream & operator= (CppOStream &&)=delete
 ~CppOStream () override
Public Member Functions inherited from c2pa::C2paStream
 C2paStream (const C2paStream &)=delete
C2paStream & operator= (const C2paStream &)=delete
 C2paStream (C2paStream &&)=delete
C2paStream & operator= (C2paStream &&)=delete
virtual ~C2paStream ()

Additional Inherited Members

Public Attributes inherited from c2pa::C2paStream
::C2paStream * c_stream = nullptr
 Pointer to the underlying C2paStream.
Protected Member Functions inherited from c2pa::C2paStream
 C2paStream ()=default

Detailed Description

Output stream OStream wrapper for C2paStream.

This class is used to wrap an output stream for use with the C2PA library.

Constructor & Destructor Documentation

◆ CppOStream() [1/3]

template<typename OStream>
c2pa::CppOStream::CppOStream ( OStream & ostream)
inlineexplicit

Construct an output stream wrapper from a std::ostream-derived object.

Template Parameters
OStreamType derived from std::ostream.
Parameters
ostreamThe output stream to wrap (must be open and valid).
Exceptions
C2paExceptionif stream wrapper creation fails.
635 {
636 static_assert(std::is_base_of<std::ostream, OStream>::value, "Stream must be derived from std::ostream");
637 // Upcast to std::ostream* before type erasure; the callbacks cast the context back to std::ostream*
638 c_stream = c2pa_create_stream(reinterpret_cast<StreamContext *>(static_cast<std::ostream *>(&ostream)), reader, seeker, writer, flusher);
639 if (c_stream == nullptr) {
640 throw C2paException("Failed to create output stream wrapper: is stream open and valid?");
641 }
642 }
::C2paStream * c_stream
Pointer to the underlying C2paStream.
Definition c2pa.hpp:552

◆ CppOStream() [2/3]

c2pa::CppOStream::CppOStream ( const CppOStream & )
delete

◆ CppOStream() [3/3]

c2pa::CppOStream::CppOStream ( CppOStream && )
delete

◆ ~CppOStream()

c2pa::CppOStream::~CppOStream ( )
override

Member Function Documentation

◆ operator=() [1/2]

CppOStream & c2pa::CppOStream::operator= ( const CppOStream & )
delete

◆ operator=() [2/2]

CppOStream & c2pa::CppOStream::operator= ( CppOStream && )
delete

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