DocWire SDK
DocWire SDK: Award-winning modern data processing in C++20. SourceForge Community Choice & Microsoft support. AI-driven processing. Supports nearly 100 data formats, including email boxes and OCR. Boost efficiency in text extraction, web data extraction, data mining, document analysis. Offline processing possible for security and confidentiality
docwire::output_chain_element Class Reference

output_chain_element class is responsible for saving data from parsing chain to an output stream. More...

#include <output.h>

Inheritance diagram for docwire::output_chain_element:
docwire::chain_element docwire::with_pimpl< chain_element > docwire::with_pimpl_base

Public Member Functions

 output_chain_element (ref_or_owned< std::ostream > out_stream)
 
 output_chain_element (ref_or_owned< std::vector< message_ptr >> out_vector)
 
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...
 
virtual continuation operator() (message_ptr msg, const message_callbacks &emit_message) override
 
- Public Member Functions inherited from docwire::chain_element
 chain_element (chain_element &&)=default
 
chain_elementoperator= (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 Member Functions inherited from docwire::with_pimpl< chain_element >
impl_typecreate_impl (Args &&... args)
 
 with_pimpl (Args &&... args)
 
 with_pimpl (with_pimpl< chain_element > &&other) noexcept
 
 with_pimpl (std::nullptr_t)
 
with_pimploperator= (with_pimpl &&other) noexcept
 
impl_typeimpl ()
 
const impl_typeimpl () const
 

Detailed Description

output_chain_element class is responsible for saving data from parsing chain to an output stream.

std::ifstream("file.pdf", std::ios_base::in|std::ios_base::binary) | office_formats_parser{} | plain_text_exporter() | std::cout; // Imports file.pdf and saves it to std::cout as plain text

Definition at line 38 of file output.h.

Constructor & Destructor Documentation

◆ output_chain_element()

docwire::output_chain_element::output_chain_element ( ref_or_owned< std::ostream >  out_stream)
inline
Parameters
out_streamoutput_chain_element stream. Parsing chain will be writing to this stream.

Definition at line 44 of file output.h.

Member Function Documentation

◆ is_leaf()

bool docwire::output_chain_element::is_leaf ( ) const
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 52 of file output.h.


The documentation for this class was generated from the following file: