MySQL 8.3.0
Source Code Documentation
Compressed_ostream Class Reference

#include <basic_ostream.h>

Inheritance diagram for Compressed_ostream:
[legend]

Public Member Functions

 Compressed_ostream (Compressor_ptr_t compressor, Managed_buffer_sequence_t &managed_buffer_sequence)
 
 ~Compressed_ostream () override=default
 
 Compressed_ostream ()=delete
 
 Compressed_ostream (const Compressed_ostream &)=delete
 
Compressed_ostreamoperator= (const Compressed_ostream &)=delete
 
bool write (const unsigned char *buffer, my_off_t length) override
 Compress the given bytes into the buffer sequence. More...
 
Status_t get_status () const
 
- Public Member Functions inherited from Basic_ostream
virtual ~Basic_ostream ()=default
 

Private Types

using Compressor_t = mysql::binlog::event::compression::Compressor
 
using Compressor_ptr_t = std::shared_ptr< Compressor_t >
 
using Status_t = mysql::binlog::event::compression::Compress_status
 
using Managed_buffer_sequence_t = Compressor_t::Managed_buffer_sequence_t
 

Private Attributes

Compressor_ptr_t m_compressor
 
Managed_buffer_sequence_tm_managed_buffer_sequence
 
Status_t m_status = Status_t::success
 

Member Typedef Documentation

◆ Compressor_ptr_t

using Compressed_ostream::Compressor_ptr_t = std::shared_ptr<Compressor_t>
private

◆ Compressor_t

◆ Managed_buffer_sequence_t

◆ Status_t

Constructor & Destructor Documentation

◆ Compressed_ostream() [1/3]

Compressed_ostream::Compressed_ostream ( Compressor_ptr_t  compressor,
Managed_buffer_sequence_t managed_buffer_sequence 
)
inline

◆ ~Compressed_ostream()

Compressed_ostream::~Compressed_ostream ( )
overridedefault

◆ Compressed_ostream() [2/3]

Compressed_ostream::Compressed_ostream ( )
delete

◆ Compressed_ostream() [3/3]

Compressed_ostream::Compressed_ostream ( const Compressed_ostream )
delete

Member Function Documentation

◆ get_status()

Compressed_ostream::Status_t Compressed_ostream::get_status ( ) const

◆ operator=()

Compressed_ostream & Compressed_ostream::operator= ( const Compressed_ostream )
delete

◆ write()

bool Compressed_ostream::write ( const unsigned char *  buffer,
my_off_t  length 
)
overridevirtual

Compress the given bytes into the buffer sequence.

Note
This will consume the input, but may not produce all output; it keeps the compression frame open so that the compressor can make use of patterns across different invocations of the function. The caller has to call Compressor::finish to end the frame.
Parameters
bufferThe input buffer
lengthThe size of the input buffer
Return values
falseSuccess
trueError

Implements Basic_ostream.

Member Data Documentation

◆ m_compressor

Compressor_ptr_t Compressed_ostream::m_compressor
private

◆ m_managed_buffer_sequence

Managed_buffer_sequence_t& Compressed_ostream::m_managed_buffer_sequence
private

◆ m_status

Status_t Compressed_ostream::m_status = Status_t::success
private

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