Updating for 1.0.2 release
[awesomized/libmemcached] / libmemcached-1.0 / string.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker 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 /**
41 Strings are always under our control so we make some assumptions
42 about them.
43
44 1) is_initialized is always valid.
45 2) A string once intialized will always be, until free where we
46 unset this flag.
47 3) A string always has a root.
48 */
49
50 struct memcached_string_st {
51 char *end;
52 char *string;
53 size_t current_size;
54 memcached_st *root;
55 struct {
56 bool is_allocated:1;
57 bool is_initialized:1;
58 } options;
59 };
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 LIBMEMCACHED_LOCAL
66 memcached_string_st *memcached_string_create(memcached_st *ptr,
67 memcached_string_st *string,
68 size_t initial_size);
69 LIBMEMCACHED_LOCAL
70 memcached_return_t memcached_string_check(memcached_string_st *string, size_t need);
71
72 LIBMEMCACHED_LOCAL
73 char *memcached_string_c_copy(memcached_string_st *string);
74
75 LIBMEMCACHED_LOCAL
76 memcached_return_t memcached_string_append_character(memcached_string_st *string,
77 char character);
78 LIBMEMCACHED_LOCAL
79 memcached_return_t memcached_string_append(memcached_string_st *string,
80 const char *value, size_t length);
81 LIBMEMCACHED_LOCAL
82 memcached_return_t memcached_string_reset(memcached_string_st *string);
83
84 LIBMEMCACHED_LOCAL
85 void memcached_string_free(memcached_string_st *string);
86
87 LIBMEMCACHED_LOCAL
88 size_t memcached_string_length(const memcached_string_st *self);
89
90 LIBMEMCACHED_LOCAL
91 size_t memcached_string_size(const memcached_string_st *self);
92
93 LIBMEMCACHED_LOCAL
94 const char *memcached_string_value(const memcached_string_st *self);
95
96 LIBMEMCACHED_LOCAL
97 char *memcached_string_take_value(memcached_string_st *self);
98
99 LIBMEMCACHED_LOCAL
100 char *memcached_string_value_mutable(const memcached_string_st *self);
101
102 LIBMEMCACHED_LOCAL
103 void memcached_string_set_length(memcached_string_st *self, size_t length);
104
105 #ifdef __cplusplus
106 }
107 #endif