aboutsummaryrefslogtreecommitdiff
path: root/src/IsCharacterInSet.hpp
blob: f17460cd35ac9272e16ee15b41616a9b1ea63764 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#ifndef URI_IS_CHARACTER_IN_SET_HPP
#define URI_IS_CHARACTER_IN_SET_HPP

/**
 * @file IsCharacterInSet.hpp
 *
 * This module declares the Uri::IsCharacterInSet class.
 *
 * © 2018 by Richard Walters
 */

#include <initializer_list>

namespace Uri {

    /**
     * This function determines whether or not the given character
     * is in the given character set.
     *
     * @param[in] c
     *     This is the character to check.
     *
     * @param[in] characterSet
     *     This is the set of characters that are allowed.
     *
     * @return
     *     An indication of whether or not the given character
     *     is in the given character set is returned.
     */
    bool IsCharacterInSet(
        char c,
        std::initializer_list< char > characterSet
    );

}

#endif /* URI_IS_CHARACTER_IN_SET_HPP */