binary.h 2.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*  Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

17 18 19 20 21 22 23 24 25 26 27
/*!
 * \file includes.h
 *
 * \author Jan Vcelak <jan.vcelak@nic.cz>
 *
 * \brief Structures for binary data handling.
 *
 * \addtogroup libknot
 * @{
 */

28
#pragma once
29 30 31 32 33 34 35 36 37 38 39 40

#include <stdlib.h>
#include <stddef.h>
#include <stdint.h>

struct knot_binary {
	uint8_t *data;
	size_t size;
};

typedef struct knot_binary knot_binary_t;

41 42 43
/*!
 * \brief Initialize knot_binary_t structure from Base64 encoded string.
 *
44
 * \param base64  Base64 encoded input data.
45
 * \param to      Pointer to structure to write the result into.
46
 * \return Error code, KNOT_EOK in case of success.
47
 */
48 49 50 51 52 53 54 55 56 57 58
int knot_binary_from_base64(const char *base64, knot_binary_t *to);

/*!
 * \brief Initialize knot_binary_t structure from binary string.
 *
 * \param data  Pointer to binary data string.
 * \param size  Size of the binary data.
 * \param to    Pointer to structure to write the result into.
 * \return Error code, KNOT_EOK in case of success.
 */
int knot_binary_from_string(const uint8_t *data, size_t size, knot_binary_t *to);
59 60 61 62

/*!
 * \brief Free content of knot_binary_t structure.
 *
63 64
 * \param binary  Pointer to the structure.
 * \return Error code, KNOT_EOK in case of success.
65 66 67
 */
int knot_binary_free(knot_binary_t *binary);

68 69 70 71 72 73 74 75 76 77 78
/*!
 * \brief Create deep copy of knot_binary_t structure.
 *
 * (Does nothing if source structure is empty.)
 *
 * \param from   Source structure.
 * \param to     Target structure.
 * \return Error code, KNOT_EOK if case of success.
 */
int knot_binary_dup(const knot_binary_t *from, knot_binary_t *to);

79
/*! @} */