libhext: C++ Library Documentation  1.0.8-3ad0ae4
PrependPipe.h
Go to the documentation of this file.
1 // Copyright 2015, 2016 Thomas Trapp
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef HEXT_PREPEND_PIPE_H_INCLUDED
16 #define HEXT_PREPEND_PIPE_H_INCLUDED
17 
18 /// @file
19 /// Declares hext::PrependPipe
20 
21 #include "hext/Cloneable.h"
22 #include "hext/StringPipe.h"
23 #include "hext/Visibility.h"
24 
25 #include <string>
26 
27 
28 namespace hext {
29 
30 
31 /// Prepends a given string to a string.
33  : public hext::Cloneable<PrependPipe, StringPipe>
34 {
35 public:
36  /// Constructs a PrependPipe.
37  ///
38  /// @param prefix: The string to prepend.
39  explicit PrependPipe(std::string prefix) noexcept;
40 
41  /// Prepends a given string to str.
42  std::string transform(std::string str) const override;
43 
44 private:
45  std::string prefix_;
46 };
47 
48 
49 } // namespace hext
50 
51 
52 #endif // HEXT_PREPEND_PIPE_H_INCLUDED
53 
Defines template hext::Cloneable.
Declares hext::StringPipe.
Defines HEXT_PUBLIC and HEXT_PRIVATE.
#define HEXT_PUBLIC
Definition: Visibility.h:26
Curiously recurring template pattern that extends a base class to provide a virtual method Cloneable:...
Definition: Cloneable.h:37
Prepends a given string to a string.
Definition: PrependPipe.h:34
std::string transform(std::string str) const override
Prepends a given string to str.
PrependPipe(std::string prefix) noexcept
Constructs a PrependPipe.