1 /*------------------------------------------------------------------------------
2  *
3  * Copyright (c) 2011-2021, EURid vzw. All rights reserved.
4  * The YADIFA TM software product is provided under the BSD 3-clause license:
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  *        * Redistributions of source code must retain the above copyright
11  *          notice, this list of conditions and the following disclaimer.
12  *        * Redistributions in binary form must reproduce the above copyright
13  *          notice, this list of conditions and the following disclaimer in the
14  *          documentation and/or other materials provided with the distribution.
15  *        * Neither the name of EURid nor the names of its contributors may be
16  *          used to endorse or promote products derived from this software
17  *          without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  *------------------------------------------------------------------------------
32  *
33  */
34 
35 /** @defgroup streaming Streams
36  *  @ingroup dnscore
37  *  @brief
38  *
39  *
40  *
41  * @{
42  *
43  *----------------------------------------------------------------------------*/
44 #ifndef _BYTEARRAY_INPUT_STREAM_H
45 #define	_BYTEARRAY_INPUT_STREAM_H
46 
47 #include <dnscore/input_stream.h>
48 
49 #ifdef	__cplusplus
50 extern "C" {
51 #endif
52 
53 void bytearray_input_stream_init_const(input_stream* out_stream, const void* array, u32 size);
54 
55 void bytearray_input_stream_init(input_stream* out_stream, void* array, u32 size, bool owned);
56 
57 void bytearray_input_stream_reset(input_stream* stream);
58 
59 void bytearray_input_stream_update(input_stream* stream, void* array, u32 size, bool owned);
60 
61 u32 bytearray_input_stream_offset(const input_stream* stream);
62 u32 bytearray_input_stream_set_offset(input_stream* stream, u32 offset);
63 
64 u32 bytearray_input_stream_size(const input_stream* stream);
65 u32 bytearray_input_stream_remaining(const input_stream* stream);
66 const u8* bytearray_input_stream_buffer(const input_stream* stream);
67 u8* bytearray_input_stream_detach(input_stream* stream);
68 
69 bool bytearray_input_stream_is_instance_of(const input_stream* stream);
70 
71 /**
72  * Z-allocate a byte array input stream matching the one passed as a parameter.
73  * Offset is matched.
74  * Buffer is owned.
75  */
76 
77 input_stream *bytearray_input_stream_clone(const input_stream* stream);
78 
79 #ifdef	__cplusplus
80 }
81 #endif
82 
83 #endif	/* _BYTEARRAY_INPUT_STREAM_H */
84 /** @} */
85 
86