libart-paperback 0.1.0-a.1.20260122225059.e5fea306241a
PDF (1.4) library for C++
Art::Paperback::Carousel::Stream Class Reference

Represents a COS stream. More...

#include <art/paperback/carousel/stream.hxx>

Inheritance diagram for Art::Paperback::Carousel::Stream:

Classes

struct  Internal
 

Public Member Functions

 Stream ()
 Constructor.
 
 Stream (Stream const &)
 Constructor.
 
 Stream (Stream &&)
 Constructor.
 
 ~Stream () noexcept
 Destructor.
 
void clear ()
 Clear stream.
 
Dictionary as_dictionary () const
 Returns the stream metadata as a dictionary.
 
string str () const
 Access the buffer as a string.
 
std::basic_streambuf< char > * rdbuf () const
 Access buffer.
 
iostream * operator-> ()
 Access data stream.
 
iostream const * operator-> () const
 Access data stream.
 
iostream & operator* ()
 Access data stream.
 
iostream const & operator* () const
 Access data stream.
 
Streamoperator= (Stream const &)
 Assignment.
 
Streamoperator= (Stream &&)
 Assignment.
 
bool operator== (Stream const &) const
 Comparison.
 
bool operator!= (Stream const &) const
 Comparison.
 
void attach (Owner &)
 Attach value to owner.
 
Owner * owner ()
 Access owner, if any.
 
Owner const * owner () const
 Access owner, if any.
 

Protected Member Functions

virtual void attach_children (Owner &)
 Attach any children.
 

Private Attributes

unique_ptr< Internal_internal
 
Owner * _owner {}
 

Detailed Description

Represents a COS stream.

A stream is a special COS object type containing a data stream of bytes.

A stream object is always an indirect object.

Constructor & Destructor Documentation

◆ Stream() [1/3]

Art::Paperback::Carousel::Stream::Stream ( )

Constructor.

◆ Stream() [2/3]

Art::Paperback::Carousel::Stream::Stream ( Stream const & other)

Constructor.

◆ Stream() [3/3]

Art::Paperback::Carousel::Stream::Stream ( Stream && other)

Constructor.

◆ ~Stream()

Art::Paperback::Carousel::Stream::~Stream ( )
noexcept

Destructor.

Member Function Documentation

◆ clear()

void Art::Paperback::Carousel::Stream::clear ( )

Clear stream.

◆ as_dictionary()

Dictionary Art::Paperback::Carousel::Stream::as_dictionary ( ) const

Returns the stream metadata as a dictionary.

◆ str()

string Art::Paperback::Carousel::Stream::str ( ) const

Access the buffer as a string.

◆ rdbuf()

std::basic_streambuf< char > * Art::Paperback::Carousel::Stream::rdbuf ( ) const

Access buffer.

◆ operator->() [1/2]

iostream * Art::Paperback::Carousel::Stream::operator-> ( )

Access data stream.

◆ operator->() [2/2]

iostream const * Art::Paperback::Carousel::Stream::operator-> ( ) const

Access data stream.

◆ operator*() [1/2]

iostream & Art::Paperback::Carousel::Stream::operator* ( )

Access data stream.

◆ operator*() [2/2]

iostream const & Art::Paperback::Carousel::Stream::operator* ( ) const

Access data stream.

◆ operator=() [1/2]

Stream & Art::Paperback::Carousel::Stream::operator= ( Stream const & other)

Assignment.

◆ operator=() [2/2]

Stream & Art::Paperback::Carousel::Stream::operator= ( Stream && other)

Assignment.

◆ operator==()

bool Art::Paperback::Carousel::Stream::operator== ( Stream const & other) const

Comparison.

◆ operator!=()

bool Art::Paperback::Carousel::Stream::operator!= ( Stream const & other) const

Comparison.

◆ attach()

void Art::Paperback::Carousel::Object_model::Value_base::attach ( Owner & owner)
inherited

Attach value to owner.

Parameters
ownerReference to the owner.

◆ owner() [1/2]

Owner * Art::Paperback::Carousel::Object_model::Value_base::owner ( )
inherited

Access owner, if any.

Returns
Returns a pointer to the owner, if attached.

◆ owner() [2/2]

Owner const * Art::Paperback::Carousel::Object_model::Value_base::owner ( ) const
inherited

Access owner, if any.

Returns
Returns a pointer to the owner, if attached.

◆ attach_children()

void Art::Paperback::Carousel::Object_model::Value_base::attach_children ( Owner & owner)
protectedvirtualinherited

Attach any children.

Parameters
ownerThe owner of the children.

Reimplemented in Art::Paperback::Carousel::Array, and Art::Paperback::Carousel::Dictionary.