MySQL 9.4.0
Source Code Documentation
none_comp.h
Go to the documentation of this file.
1/* Copyright (c) 2019, 2025, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef MYSQL_BINLOG_EVENT_COMPRESSION_NONE_COMP_H
25#define MYSQL_BINLOG_EVENT_COMPRESSION_NONE_COMP_H
26
28
30
31/// Compressor subclass that only copies input to output without
32/// compressing it.
33class None_comp : public Compressor {
34 public:
35 using typename Compressor::Char_t;
37 using typename Compressor::Size_t;
38 static constexpr type type_code = NONE;
39
40 private:
41 /// @return NONE
42 type do_get_type_code() const override;
43
44 /// @copydoc Compressor::do_reset
45 ///
46 /// No-op for this class.
47 void do_reset() override;
48
49 /// @copydoc Compressor::do_feed
50 void do_feed(const Char_t *input_data, Size_t input_size) override;
51
52 /// @copydoc Compressor::do_compress
53 ///
54 /// For None_comp, this is guaranteed to produce all output on
55 /// success.
56 [[nodiscard]] Compress_status do_compress(
57 Managed_buffer_sequence_t &out) override;
58
59 /// @copydoc Compressor::do_finish
60 ///
61 /// For None_comp, this is equivalent to @c compress.
62 [[nodiscard]] Compress_status do_finish(
63 Managed_buffer_sequence_t &out) override;
64
65 /// Data previously provided to @c do_feed.
66 const Char_t *m_input_data{nullptr};
67
68 /// Size data previously provided to @c do_feed.
70};
71
72} // namespace mysql::binlog::event::compression
73
74#endif // MYSQL_BINLOG_EVENT_COMPRESSION_NONE_COMP_H
Abstract base class for compressors.
Definition: compressor.h:79
Managed_buffer_sequence_t::Size_t Size_t
Definition: compressor.h:84
Managed_buffer_sequence_t::Char_t Char_t
Definition: compressor.h:83
mysql::containers::buffers::Managed_buffer_sequence<> Managed_buffer_sequence_t
Definition: compressor.h:82
Compressor subclass that only copies input to output without compressing it.
Definition: none_comp.h:33
void do_feed(const Char_t *input_data, Size_t input_size) override
Implement feed.
Definition: none_comp.cpp:37
Compress_status do_compress(Managed_buffer_sequence_t &out) override
Implement compress.
Definition: none_comp.cpp:43
Compress_status do_finish(Managed_buffer_sequence_t &out) override
Implement finish.
Definition: none_comp.cpp:50
void do_reset() override
Implement reset.
Definition: none_comp.cpp:32
static constexpr type type_code
Definition: none_comp.h:38
const Char_t * m_input_data
Data previously provided to do_feed.
Definition: none_comp.h:66
type do_get_type_code() const override
Definition: none_comp.cpp:30
Size_t m_input_size
Size data previously provided to do_feed.
Definition: none_comp.h:69
Owned, non-contiguous, growable memory buffer.
Definition: managed_buffer_sequence.h:114
Definition: base.cpp:27
@ NONE
Definition: base.h:45
Grow_status
Error statuses for classes that use Grow_calculator.
Definition: grow_status.h:38