bool-sink.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2024 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_BOOL_SINK_HPP
23 #define NDN_CXX_SECURITY_TRANSFORM_BOOL_SINK_HPP
24 
26 
27 namespace ndn::security::transform {
28 
35 class BoolSink : public Sink
36 {
37 public:
41  explicit
42  BoolSink(bool& value)
43  : m_value(value)
44  {
45  }
46 
47 private:
53  size_t
54  doWrite(span<const uint8_t> buf) final;
55 
59  void
60  doEnd() final
61  {
62  // nothing to do
63  }
64 
65 private:
66  bool m_hasValue = false;
67  bool& m_value;
68 };
69 
70 unique_ptr<Sink>
71 boolSink(bool& value);
72 
73 } // namespace ndn::security::transform
74 
75 #endif // NDN_CXX_SECURITY_TRANSFORM_BOOL_SINK_HPP
A sink which outputs only one boolean value.
Definition: bool-sink.hpp:36
BoolSink(bool &value)
Create a bool sink whose output will be stored in value.
Definition: bool-sink.hpp:42
Abstraction of the transformation sink module.
unique_ptr< Sink > boolSink(bool &value)
Definition: bool-sink.cpp:37
There are three types of module in a transformation chain: Source, Transform, and Sink.