git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/string.h

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary: String structure used for libmemcached.
   9  *
  10  */
  11
  12 #pragma once
  13 #ifndef __LIBMEMCACHED_STRING_H__
  14 #define __LIBMEMCACHED_STRING_H__
  15
  16 /**
  17   Strings are always under our control so we make some assumptions
  18   about them.
  19
  20   1) is_initialized is always valid.
  21   2) A string once intialized will always be, until free where we
  22      unset this flag.
  23   3) A string always has a root.
  24 */
  25
  26 struct memcached_string_st {
  27   char *end;
  28   char *string;
  29   size_t current_size;
  30   const memcached_st *root;
  31   struct {
  32     bool is_allocated:1;
  33     bool is_initialized:1;
  34   } options;
  35 };
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 LIBMEMCACHED_LOCAL
  42 memcached_string_st *memcached_string_create(const memcached_st *ptr,
  43                                              memcached_string_st *string,
  44                                              size_t initial_size);
  45 LIBMEMCACHED_LOCAL
  46 memcached_return_t memcached_string_check(memcached_string_st *string, size_t need);
  47
  48 LIBMEMCACHED_LOCAL
  49 char *memcached_string_c_copy(memcached_string_st *string);
  50
  51 LIBMEMCACHED_LOCAL
  52 memcached_return_t memcached_string_append_character(memcached_string_st *string,
  53                                                      char character);
  54 LIBMEMCACHED_LOCAL
  55 memcached_return_t memcached_string_append(memcached_string_st *string,
  56                                            const char *value, size_t length);
  57 LIBMEMCACHED_LOCAL
  58 memcached_return_t memcached_string_reset(memcached_string_st *string);
  59
  60 LIBMEMCACHED_LOCAL
  61 void memcached_string_free(memcached_string_st *string);
  62
  63 LIBMEMCACHED_LOCAL
  64 size_t memcached_string_length(const memcached_string_st *self);
  65
  66 LIBMEMCACHED_LOCAL
  67 size_t memcached_string_size(const memcached_string_st *self);
  68
  69 LIBMEMCACHED_LOCAL
  70 const char *memcached_string_value(const memcached_string_st *self);
  71
  72 LIBMEMCACHED_LOCAL
  73 char *memcached_string_value_mutable(const memcached_string_st *self);
  74
  75 LIBMEMCACHED_LOCAL
  76 void memcached_string_set_length(memcached_string_st *self, size_t length);
  77
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82
  83 #endif /* __LIBMEMCACHED_STRING_H__ */