.. _program_listing_file_include_rcutils_types_char_array.h:

Program Listing for File char_array.h
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_rcutils_types_char_array.h>` (``include/rcutils/types/char_array.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018 Open Source Robotics Foundation, Inc.
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.
   
   
   #ifndef RCUTILS__TYPES__CHAR_ARRAY_H_
   #define RCUTILS__TYPES__CHAR_ARRAY_H_
   
   #if __cplusplus
   extern "C"
   {
   #endif
   
   #include <stdarg.h>
   
   #include "rcutils/allocator.h"
   #include "rcutils/types/rcutils_ret.h"
   #include "rcutils/visibility_control.h"
   
   typedef struct RCUTILS_PUBLIC_TYPE rcutils_char_array_s
   {
     char * buffer;
   
     bool owns_buffer;
   
     size_t buffer_length;
   
     size_t buffer_capacity;
   
     rcutils_allocator_t allocator;
   } rcutils_char_array_t;
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_char_array_t
   rcutils_get_zero_initialized_char_array(void);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_init(
     rcutils_char_array_t * char_array,
     size_t buffer_capacity,
     const rcutils_allocator_t * allocator);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_fini(rcutils_char_array_t * char_array);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_resize(rcutils_char_array_t * char_array, size_t new_size);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_expand_as_needed(rcutils_char_array_t * char_array, size_t new_size);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_vsprintf(rcutils_char_array_t * char_array, const char * format, va_list args);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_strncat(rcutils_char_array_t * char_array, const char * src, size_t n);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_strcat(rcutils_char_array_t * char_array, const char * src);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_memcpy(rcutils_char_array_t * char_array, const char * src, size_t n);
   
   
   RCUTILS_PUBLIC
   RCUTILS_WARN_UNUSED
   rcutils_ret_t
   rcutils_char_array_strcpy(rcutils_char_array_t * char_array, const char * src);
   
   #if __cplusplus
   }
   #endif
   
   #endif  // RCUTILS__TYPES__CHAR_ARRAY_H_