jenkins-promote-staging-trunk-libmemcached-7
[awesomized/libmemcached] / libmemcached / string.hpp
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * libmcachedd client library.
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 #pragma once
39
40 #include "util/string.hpp"
41
42 #define memcached_literal_param util_literal_param
43 #define memcached_literal_param_size util_literal_param_size
44 #define memcached_string_make_from_cstr util_string_make_from_cstr
45 #define memcached_array_length util_array_length
46
47 /**
48 Strings are always under our control so we make some assumptions
49 about them.
50
51 1) is_initialized is always valid.
52 2) A string once intialized will always be, until free where we
53 unset this flag.
54 3) A string always has a root.
55 */
56
57 memcached_string_st *memcached_string_create(memcached_st *ptr,
58 memcached_string_st *string,
59 size_t initial_size);
60
61 memcached_return_t memcached_string_check(memcached_string_st *string, size_t need);
62
63 char *memcached_string_c_copy(memcached_string_st *string);
64
65 memcached_return_t memcached_string_append_character(memcached_string_st *string,
66 char character);
67
68 memcached_return_t memcached_string_append(memcached_string_st *string,
69 const char *value, size_t length);
70
71 memcached_return_t memcached_string_reset(memcached_string_st *string);
72
73 void memcached_string_free(memcached_string_st *string);
74
75 size_t memcached_string_length(const memcached_string_st *self);
76
77 size_t memcached_string_size(const memcached_string_st *self);
78
79 const char *memcached_string_value(const memcached_string_st *self);
80
81 char *memcached_string_take_value(memcached_string_st *self);
82
83 char *memcached_string_value_mutable(const memcached_string_st *self);
84
85 void memcached_string_set_length(memcached_string_st *self, size_t length);