the generic class, parent of all masks
More...
#include <mask.hpp>
|
| mask (const mask &ref)=default |
| mask (mask &&ref) noexcept=default |
mask & | operator= (const mask &ref)=default |
mask & | operator= (mask &&ref) noexcept=default |
virtual bool | is_covered (const std::string &expression) const=0 |
| check wether the given string is covered by the mask
|
virtual bool | is_covered (const path &chemin) const |
| check whether the given path is covered by the mask
|
virtual std::string | dump (const std::string &prefix="") const=0 |
| dump in human readable form the nature of the mask
|
virtual mask * | clone () const=0 |
the generic class, parent of all masks
this is a pure virtual class that is used in API call any of the following mask classes inherit from this class
Definition at line 61 of file mask.hpp.
◆ mask()
◆ clone()
virtual mask * libdar::mask::clone |
( |
| ) |
const |
|
pure virtual |
this is to be able to copy a mask without knowing its exact class and without loosing its specialized data
◆ dump()
virtual std::string libdar::mask::dump |
( |
const std::string & | prefix = "" | ) |
const |
|
pure virtual |
dump in human readable form the nature of the mask
- Parameters
-
[in] | prefix | used for indentation withing the output string |
◆ is_covered() [1/2]
virtual bool libdar::mask::is_covered |
( |
const path & | chemin | ) |
const |
|
inlinevirtual |
check whether the given path is covered by the mask
- Parameters
-
[in] | chemin | is the path to check |
- Returns
- true if the given path is covered by the mask
- Note
- only libdar internally needs to call this method
-
this is an optional method to the previous one, it can be overwritten
Definition at line 84 of file mask.hpp.
◆ is_covered() [2/2]
virtual bool libdar::mask::is_covered |
( |
const std::string & | expression | ) |
const |
|
pure virtual |
check wether the given string is covered by the mask
- Parameters
-
[in] | expression | is the filename to check |
- Returns
- true if the given filename is covered by the mask
- Note
- only libdar internally needs to call this method
The documentation for this class was generated from the following file: