docwire::transformer_func Class Reference
Wraps single function (tag_transform_func) into chain_element object. More...
#include <transformer_func.h>
Inheritance diagram for docwire::transformer_func:
Public Member Functions | |
| transformer_func (message_transform_func transformer_function) | |
| virtual continuation | operator() (message_ptr msg, const message_callbacks &emit_message) override |
| Executes transform on the given message. More... | |
| bool | is_leaf () const override |
| Check if chain element is a leaf (last element which doesn't produce any messages). At this moment only exporters are leafs. More... | |
 Public Member Functions inherited from docwire::chain_element | |
| chain_element (chain_element &&)=default | |
| chain_element & | operator= (chain_element &&)=default |
| virtual bool | is_generator () const |
Additional Inherited Members | |
| Protected Types inherited from docwire::with_pimpl< chain_element > | |
| using | impl_type = pimpl_impl< chain_element > |
| Protected Types inherited from docwire::with_pimpl< transformer_func > | |
| using | impl_type = pimpl_impl< transformer_func > |
| Protected Member Functions inherited from docwire::with_pimpl< chain_element > | |
| impl_type * | create_impl (Args &&... args) |
| with_pimpl (Args &&... args) | |
| with_pimpl (with_pimpl< chain_element > &&other) noexcept | |
| with_pimpl (std::nullptr_t) | |
| with_pimpl & | operator= (with_pimpl &&other) noexcept |
| impl_type & | impl () |
| const impl_type & | impl () const |
| Protected Member Functions inherited from docwire::with_pimpl< transformer_func > | |
| impl_type * | create_impl (Args &&... args) |
| with_pimpl (Args &&... args) | |
| with_pimpl (with_pimpl< transformer_func > &&other) noexcept | |
| with_pimpl (std::nullptr_t) | |
| with_pimpl & | operator= (with_pimpl &&other) noexcept |
| impl_type & | impl () |
| const impl_type & | impl () const |
Detailed Description
Wraps single function (tag_transform_func) into chain_element object.
Definition at line 28 of file transformer_func.h.
Constructor & Destructor Documentation
◆ transformer_func()
| docwire::transformer_func::transformer_func | ( | message_transform_func | transformer_function | ) |
- Parameters
-
transformer_function callback function, which will be called in transform().
Member Function Documentation
◆ is_leaf()
|
inlineoverridevirtual |
Check if chain element is a leaf (last element which doesn't produce any messages). At this moment only exporters are leafs.
- Returns
- true if leaf
Implements docwire::chain_element.
Definition at line 44 of file transformer_func.h.
◆ operator()()
|
overridevirtual |
Executes transform on the given message.
- See also
- docwire::message_ptr
- Parameters
-
msg Incoming message. emit_message Callback to emit downstream messages.
Implements docwire::chain_element.
The documentation for this class was generated from the following file:
