xref: /5.5.2/platform/include/platform/string.h (revision 5c6a39bc)
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 *     Copyright 2017 Couchbase, Inc.
4 *
5 *   Licensed under the Apache License, Version 2.0 (the "License");
6 *   you may not use this file except in compliance with the License.
7 *   You may obtain a copy of the License at
8 *
9 *       http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *   Unless required by applicable law or agreed to in writing, software
12 *   distributed under the License is distributed on an "AS IS" BASIS,
13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *   See the License for the specific language governing permissions and
15 *   limitations under the License.
16 */
17#pragma once
18
19#include <platform/visibility.h>
20
21#include <cstdint>
22#include "sized_buffer.h"
23
24namespace cb {
25/**
26 * Get the value for a string of hex characters
27 *
28 * @param buffer the input buffer
29 * @return the value of the string
30 * @throws std::invalid_argument for an invalid character in the string
31 *         std::overflow_error if the input string won't fit in uint64_t
32 */
33PLATFORM_PUBLIC_API
34uint64_t from_hex(cb::const_char_buffer buffer);
35
36PLATFORM_PUBLIC_API
37std::string to_hex(uint8_t val);
38
39PLATFORM_PUBLIC_API
40std::string to_hex(uint16_t val);
41
42PLATFORM_PUBLIC_API
43std::string to_hex(uint32_t val);
44
45PLATFORM_PUBLIC_API
46std::string to_hex(uint64_t val);
47
48} // namespace cb
49