tudocomp
– The TU Dortmund Compression Framework
Public Member Functions | Friends | List of all members
tdc::io::InputRestrictions Class Reference

Describes a set of restrictions placed on input data. More...

#include <InputRestrictions.hpp>

Inheritance diagram for tdc::io::InputRestrictions:
tdc::ds::InputRestrictionsAndFlags

Public Member Functions

 InputRestrictions (const std::vector< uint8_t > &escape_bytes={}, bool null_terminate=false)
 
const std::vector< uint8_t > & escape_bytes () const
 
bool null_terminate () const
 
bool has_no_escape_restrictions () const
 
bool has_no_restrictions () const
 
bool has_escape_restrictions () const
 
bool has_restrictions () const
 

Friends

InputRestrictions operator| (const InputRestrictions &a, const InputRestrictions &b)
 Merges two InpuTrestrictions to a combined set of restrictions. More...
 

Detailed Description

Describes a set of restrictions placed on input data.

Restrictions include illigal bytes in the input (called escape bytes here), and wether the input needs to be null terminated.

Definition at line 10 of file InputRestrictions.hpp.

Constructor & Destructor Documentation

◆ InputRestrictions()

tdc::io::InputRestrictions::InputRestrictions ( const std::vector< uint8_t > &  escape_bytes = {},
bool  null_terminate = false 
)
inline

Definition at line 23 of file InputRestrictions.hpp.

Member Function Documentation

◆ escape_bytes()

const std::vector<uint8_t>& tdc::io::InputRestrictions::escape_bytes ( ) const
inline

Definition at line 30 of file InputRestrictions.hpp.

◆ has_escape_restrictions()

bool tdc::io::InputRestrictions::has_escape_restrictions ( ) const
inline

Definition at line 46 of file InputRestrictions.hpp.

◆ has_no_escape_restrictions()

bool tdc::io::InputRestrictions::has_no_escape_restrictions ( ) const
inline

Definition at line 38 of file InputRestrictions.hpp.

◆ has_no_restrictions()

bool tdc::io::InputRestrictions::has_no_restrictions ( ) const
inline

Definition at line 42 of file InputRestrictions.hpp.

◆ has_restrictions()

bool tdc::io::InputRestrictions::has_restrictions ( ) const
inline

Definition at line 50 of file InputRestrictions.hpp.

◆ null_terminate()

bool tdc::io::InputRestrictions::null_terminate ( ) const
inline

Definition at line 34 of file InputRestrictions.hpp.

Friends And Related Function Documentation

◆ operator|

InputRestrictions operator| ( const InputRestrictions &  a,
const InputRestrictions &  b 
)
friend

Merges two InpuTrestrictions to a combined set of restrictions.

Definition at line 64 of file InputRestrictions.hpp.

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