A validator that checks if a given path is a valid input directory. More...
#include <seqan3/argument_parser/validators.hpp>
Public Types | |
using | option_value_type = std::string |
Type of values that are tested by validator. | |
Public Member Functions | |
std::string | get_help_page_message () const |
Returns a message that can be appended to the (positional) options help page info. | |
template<std::ranges::forward_range range_type> | |
void | operator() (range_type const &v) const |
Tests whether every path in list v passes validation. See operator()(option_value_type const & value) for further information. More... | |
virtual void | operator() (std::filesystem::path const &dir) const override |
Tests whether path is an existing directory and is readable. More... | |
Constructors, destructor and assignment | |
input_directory_validator ()=default | |
Defaulted. | |
input_directory_validator (input_directory_validator const &)=default | |
Defaulted. | |
input_directory_validator (input_directory_validator &&)=default | |
Defaulted. | |
input_directory_validator & | operator= (input_directory_validator const &)=default |
Defaulted. | |
input_directory_validator & | operator= (input_directory_validator &&)=default |
Defaulted. | |
virtual | ~input_directory_validator ()=default |
Virtual Destructor. | |
file_validator_base ()=default | |
Defaulted. | |
file_validator_base (file_validator_base const &)=default | |
Defaulted. | |
file_validator_base (file_validator_base &&)=default | |
Defaulted. | |
Protected Member Functions | |
std::string | valid_extensions_help_page_message () const |
Returns the information of valid file extensions. | |
void | validate_filename (std::filesystem::path const &path) const |
Validates the given filename path based on the specified extensions. More... | |
void | validate_readability (std::filesystem::path const &path) const |
Checks if the given path is readable. More... | |
void | validate_writeability (std::filesystem::path const &path) const |
Checks if the given path is writable. More... | |
Protected Attributes | |
std::vector< std::string > | extensions {} |
Stores the extensions. | |
Related Functions | |
(Note that these are not member functions.) | |
Requirements for seqan3::validator | |
You can expect these (meta-)functions on all types that implement seqan3::validator. | |
void | operator() (option_value_type const &cmp) const |
Validates the value 'cmp' and throws a seqan3::validation_error on failure. More... | |
A validator that checks if a given path is a valid input directory.
The class acts as a functor that throws a seqan3::validation_error exception whenever a given directory (std::filesystem::path) does not exist, the specified path is not a directory, or if the directory is not readable.
|
inlineinherited |
Tests whether every path in list v
passes validation. See operator()(option_value_type const & value) for further information.
range_type | The type of range to check; must model std::ranges::forward_range and the value type must be convertible to std::filesystem::path. |
v | The input range to iterate over and check every element. |
seqan3::validation_error |
|
inlineoverridevirtual |
Tests whether path is an existing directory and is readable.
dir | The input value to check. |
seqan3::validation_error | if the validation process failed. Might be nested with std::filesystem::filesystem_error on unhandled OS API errors. |
Implements seqan3::file_validator_base.
|
inlineprotectedinherited |
Validates the given filename path based on the specified extensions.
path | The filename path. |
seqan3::validation_error | if the specified extensions don't match the given path, or std::filesystem::filesystem_error on underlying OS API errors. |
|
inlineprotectedinherited |
Checks if the given path is readable.
path | The path to check. |
true
if readable, otherwise false
. seqan3::validation_error | if the path is not readable, or std::filesystem::filesystem_error on underlying OS API errors. |
|
inlineprotectedinherited |
Checks if the given path is writable.
path | The path to check. |
true
if writable, otherwise false
. seqan3::validation_error | if the file could not be opened for writing, or std::filesystem::filesystem_error on underlying OS API errors. |
|
related |
Validates the value 'cmp' and throws a seqan3::validation_error on failure.
option_value_type | The type of the value to be validated. |
[in,out] | cmp | The value to be validated. |
seqan3::validation_error | if value 'cmp' does not pass validation. |