id3lib 3.8.3
Public Member Functions | Protected Member Functions | List of all members
ID3_MemoryWriter Class Reference

#include <writers.h>

Inheritance diagram for ID3_MemoryWriter:
ID3_Writer

Public Member Functions

 ID3_MemoryWriter ()
 
 ID3_MemoryWriter (char_type buf[], size_t size)
 
virtual ~ID3_MemoryWriter ()
 
virtual void close ()
 Close the writer.
 
virtual void flush ()
 Flush the writer.
 
virtual size_type writeChars (const char buf[], size_type len)
 Write up to len chars from buf and advance the internal position accordingly.
 
virtual size_type writeChars (const char_type buf[], size_type len)
 Write up to len characters into buf and advance the internal position accordingly.
 
virtual pos_type getCur ()
 Return the next position that will be written to.
 
virtual pos_type getBeg ()
 Return the beginning position in the writer.
 
virtual pos_type getEnd ()
 Return the first position that can't be written to.
 
- Public Member Functions inherited from ID3_Writer
virtual size_type getSize ()
 Return the number of bytes written.
 
virtual size_type getMaxSize ()
 Return the maximum number of bytes that can be written.
 
virtual int_type writeChar (char_type ch)
 Write a single character and advance the internal position.
 
virtual bool atEnd ()
 

Protected Member Functions

void setBuffer (char_type *buf, size_t size)
 

Additional Inherited Members

- Public Types inherited from ID3_Writer
typedef uint32 size_type
 
typedef uint8 char_type
 
typedef uint32 pos_type
 
typedef int32 off_type
 
typedef int16 int_type
 
- Static Public Attributes inherited from ID3_Writer
static const int_type END_OF_WRITER = -1
 

Detailed Description

Definition at line 135 of file writers.h.

Constructor & Destructor Documentation

◆ ID3_MemoryWriter() [1/2]

ID3_MemoryWriter::ID3_MemoryWriter ( )
inline

Definition at line 148 of file writers.h.

◆ ID3_MemoryWriter() [2/2]

ID3_MemoryWriter::ID3_MemoryWriter ( char_type buf[],
size_t size )
inline

Definition at line 152 of file writers.h.

◆ ~ID3_MemoryWriter()

virtual ID3_MemoryWriter::~ID3_MemoryWriter ( )
inlinevirtual

Definition at line 156 of file writers.h.

Member Function Documentation

◆ close()

virtual void ID3_MemoryWriter::close ( )
inlinevirtual

Close the writer.

Any further actions on the writer should fail.

Implements ID3_Writer.

Definition at line 157 of file writers.h.

◆ flush()

virtual void ID3_MemoryWriter::flush ( )
inlinevirtual

Flush the writer.

Implements ID3_Writer.

Definition at line 158 of file writers.h.

◆ getBeg()

virtual pos_type ID3_MemoryWriter::getBeg ( )
inlinevirtual

Return the beginning position in the writer.

Reimplemented from ID3_Writer.

Definition at line 181 of file writers.h.

◆ getCur()

virtual pos_type ID3_MemoryWriter::getCur ( )
inlinevirtual

Return the next position that will be written to.

Implements ID3_Writer.

Definition at line 176 of file writers.h.

◆ getEnd()

virtual pos_type ID3_MemoryWriter::getEnd ( )
inlinevirtual

Return the first position that can't be written to.

A return value of -1 indicates no (reasonable) limit to the writer.

Reimplemented from ID3_Writer.

Definition at line 186 of file writers.h.

◆ setBuffer()

void ID3_MemoryWriter::setBuffer ( char_type * buf,
size_t size )
inlineprotected

Definition at line 141 of file writers.h.

◆ writeChars() [1/2]

virtual size_type ID3_MemoryWriter::writeChars ( const char buf[],
size_type len )
inlinevirtual

Write up to len chars from buf and advance the internal position accordingly.

Returns the number of characters written from buf.

Reimplemented from ID3_Writer.

Definition at line 163 of file writers.h.

◆ writeChars() [2/2]

virtual size_type ID3_MemoryWriter::writeChars ( const char_type buf[],
size_type len )
inlinevirtual

Write up to len characters into buf and advance the internal position accordingly.

Returns the number of characters write into buf. Note that the value returned may be less than the number of bytes that the internal position advances, due to multi-byte characters.

Implements ID3_Writer.

Definition at line 167 of file writers.h.


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

Generated for id3lib by doxygen 1.10.0