Orcus
Public Member Functions | List of all members
orcus::iface::import_filter Class Referenceabstract

#include <interface.hpp>

Inheritance diagram for orcus::iface::import_filter:
orcus::orcus_csv orcus::orcus_gnumeric orcus::orcus_ods orcus::orcus_parquet orcus::orcus_xls_xml orcus::orcus_xlsx

Public Member Functions

 import_filter (format_t input)
 
virtual void read_file (std::string_view filepath)=0
 
virtual void read_stream (std::string_view stream)=0
 
virtual std::string_view get_name () const =0
 
void set_config (const orcus::config &v)
 
const orcus::configget_config () const
 

Detailed Description

Base interface for import filters.

Member Function Documentation

◆ get_name()

virtual std::string_view orcus::iface::import_filter::get_name ( ) const
pure virtual

Get the name of a filter.

Returns
name of a filter.

Implemented in orcus::orcus_xlsx, orcus::orcus_xls_xml, orcus::orcus_parquet, orcus::orcus_ods, orcus::orcus_gnumeric, and orcus::orcus_csv.

◆ read_file()

virtual void orcus::iface::import_filter::read_file ( std::string_view  filepath)
pure virtual

Read the content of a file.

Parameters
filepathpath to a local file. It must be a system path.

Implemented in orcus::orcus_xlsx, orcus::orcus_xls_xml, orcus::orcus_parquet, orcus::orcus_ods, orcus::orcus_gnumeric, and orcus::orcus_csv.

◆ read_stream()

virtual void orcus::iface::import_filter::read_stream ( std::string_view  stream)
pure virtual

Read the content of an in-memory stream.

Parameters
streamin-memory stream to read from.

Implemented in orcus::orcus_xlsx, orcus::orcus_xls_xml, orcus::orcus_parquet, orcus::orcus_ods, orcus::orcus_gnumeric, and orcus::orcus_csv.