base64-encode.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP
24 
26 
27 namespace ndn::security::transform {
28 
32 class Base64Encode final : public Transform
33 {
34 public:
40  explicit
41  Base64Encode(bool needBreak = true);
42 
43  ~Base64Encode() final;
44 
45 private:
49  void
50  preTransform() final;
51 
56  size_t
57  convert(span<const uint8_t> data) final;
58 
64  void
65  finalize() final;
66 
70  void
71  fillOutputBuffer();
72 
76  bool
77  isConverterEmpty();
78 
79 private:
80  class Impl;
81  const unique_ptr<Impl> m_impl;
82 };
83 
84 unique_ptr<Transform>
85 base64Encode(bool needBreak = true);
86 
87 } // namespace ndn::security::transform
88 
89 #endif // NDN_CXX_SECURITY_TRANSFORM_BASE64_ENCODE_HPP
The module to perform Base64 encoding transformation.
Base64Encode(bool needBreak=true)
Create a base64 encoding module.
Abstraction of an intermediate transformation module.
unique_ptr< Transform > base64Encode(bool needBreak)
There are three types of module in a transformation chain: Source, Transform, and Sink.