xref: /curl/lib/bufref.h (revision 2bc1d775)
1 #ifndef HEADER_CURL_BUFREF_H
2 #define HEADER_CURL_BUFREF_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 
27 /*
28  * Generic buffer reference.
29  */
30 struct bufref {
31   void (*dtor)(void *);         /* Associated destructor. */
32   const unsigned char *ptr;     /* Referenced data buffer. */
33   size_t len;                   /* The data size in bytes. */
34 #ifdef DEBUGBUILD
35   int signature;                /* Detect API use mistakes. */
36 #endif
37 };
38 
39 
40 void Curl_bufref_init(struct bufref *br);
41 void Curl_bufref_set(struct bufref *br, const void *ptr, size_t len,
42                      void (*dtor)(void *));
43 const unsigned char *Curl_bufref_ptr(const struct bufref *br);
44 size_t Curl_bufref_len(const struct bufref *br);
45 CURLcode Curl_bufref_memdup(struct bufref *br, const void *ptr, size_t len);
46 void Curl_bufref_free(struct bufref *br);
47 
48 #endif
49