pressio Struct Reference

#include <pressio.h>

Public Member Functions
void	set_error (int code, std::string const &msg)
int	err_code () const
std::string const &	err_msg () const
std::shared_ptr< libpressio_compressor_plugin >	get_compressor (std::string const &compressor_id)
std::shared_ptr< libpressio_io_plugin >	get_io (std::string const &io_module_id)
template<class Str >
std::unique_ptr< libpressio_metrics_plugin >	get_metric (Str id)
template<class ForwardIt >
std::unique_ptr< libpressio_metrics_plugin >	get_metrics (ForwardIt first, ForwardIt last)

Static Public Member Functions
static const char *	version ()
static const char *	features ()
static const char *	supported_compressors ()
static const char *	supported_metrics ()
static const char *	supported_io ()
static unsigned int	major_version ()
static unsigned int	minor_version ()
static unsigned int	patch_version ()

Detailed Description

the libraries basic state

Member Function Documentation

err_code()

int pressio::err_code ( ) const

inline

Returns

the last error code for this library object

err_msg()

std::string const & pressio::err_msg ( ) const

inline

Returns

the last error message for this library object

features()

static const char * pressio::features ( )

static

Returns

the features string for this version of libpressio

See also

pressio_features

get_compressor()

std::shared_ptr< libpressio_compressor_plugin > pressio::get_compressor ( std::string const &  compressor_id )

inline

Returns an instance of a compressor

Parameters

[in]

compressor_id

name of the compressor to request

Returns

an instance of compressor registered at name, or nullptr on error

get_io()

std::shared_ptr< libpressio_io_plugin > pressio::get_io ( std::string const &  io_module_id )

inline

Returns an io module

Parameters

[in]

io_module_id

name of the compressor to request

Returns

an instance of compressor registered at name, or nullptr on error

get_metric()

template<class Str >

std::unique_ptr< libpressio_metrics_plugin > pressio::get_metric ( Str  id )

inline

Returns an metrics module

Parameters

[in]

id

name of the compressor to request

Returns

an instance of compressor registered at name, or nullptr on error

get_metrics()

template<class ForwardIt >

std::unique_ptr< libpressio_metrics_plugin > pressio::get_metrics ( ForwardIt  first, ForwardIt  last  )

inline

Returns a composite metric for all the metric_ids requested

Parameters

[in]	first	iterator to the first metric_id requested
[in]	last	iterator to the last metric_id requested

Returns

an instance of a metrics module regsitered at a name wrapping it in a composite if nessisary

major_version()

static unsigned int pressio::major_version ( )

static

Returns

the major version number of libpressio

minor_version()

static unsigned int pressio::minor_version ( )

static

Returns

the minor version number of libpressio

patch_version()

static unsigned int pressio::patch_version ( )

static

Returns

the patch version number of libpressio

set_error()

void pressio::set_error ( int  code, std::string const &  msg  )

inline

sets an error code and message

Parameters

[in]	code	non-zero represents an error
[in]	msg	a human readable description of the error

supported_compressors()

static const char * pressio::supported_compressors ( )

static

Returns

the supported compressors list for this version of libpressio

See also

pressio_supported_compressors

supported_io()

static const char * pressio::supported_io ( )

static

Returns

the supported io modules list for this version of libpressio

See also

pressio_supported_io

supported_metrics()

static const char * pressio::supported_metrics ( )

static

Returns

the supported metrics list for this version of libpressio

See also

pressio_supported_metrics

version()

static const char * pressio::version ( )

static

Returns

the version string for this version of libpressio

See also

pressio_version

---

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

• include/libpressio_ext/cpp/pressio.h