aboutsummaryrefslogtreecommitdiff
path: root/src/NormalizeCaseInsensitiveString.hpp
blob: 014dd743855eb4510084f5936cc0b65b18053a67 (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
#ifndef URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP
#define URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP

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

#include <string>

namespace Uri {

    /**
     * This function takes a string and swaps all upper-case characters
     * with their lower-case equivalents, returning the result.
     *
     * @param[in] inString
     *     This is the string to be normalized.
     *
     * @return
     *     The normalized string is returned.  All upper-case characters
     *     are replaced with their lower-case equivalents.
     */
    std::string NormalizeCaseInsensitiveString(const std::string& inString);
}

#endif /* URI_NORMALIZE_CASE_INSENSITIVE_STRING_HPP */