varint_pair.h 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. #pragma once
  2. #include <stdint.h>
  3. #include <stdbool.h>
  4. #include <stddef.h>
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8. typedef struct VarintPair VarintPair;
  9. /**
  10. * @brief Allocate a new VarintPair instance
  11. *
  12. * VarintPair is a buffer that holds pair of varint values
  13. * @return VarintPair*
  14. */
  15. VarintPair* varint_pair_alloc();
  16. /**
  17. * @brief Free a VarintPair instance
  18. *
  19. * @param pair
  20. */
  21. void varint_pair_free(VarintPair* pair);
  22. /**
  23. * @brief Write varint pair to buffer
  24. *
  25. * @param pair
  26. * @param first
  27. * @param value
  28. * @return bool pair complete and needs to be written
  29. */
  30. bool varint_pair_pack(VarintPair* pair, bool first, uint32_t value);
  31. /**
  32. * @brief Get pointer to varint pair buffer
  33. *
  34. * @param pair
  35. * @return uint8_t*
  36. */
  37. uint8_t* varint_pair_get_data(VarintPair* pair);
  38. /**
  39. * @brief Get size of varint pair buffer
  40. *
  41. * @param pair
  42. * @return size_t
  43. */
  44. size_t varint_pair_get_size(VarintPair* pair);
  45. /**
  46. * @brief Reset varint pair buffer
  47. *
  48. * @param pair
  49. */
  50. void varint_pair_reset(VarintPair* pair);
  51. /**
  52. * @brief Unpack varint pair to uint32_t pair from buffer
  53. *
  54. * @param data
  55. * @param data_length
  56. * @param value_1
  57. * @param value_2
  58. * @param length
  59. * @return bool
  60. */
  61. bool varint_pair_unpack(
  62. uint8_t* data,
  63. size_t data_length,
  64. uint32_t* value_1,
  65. uint32_t* value_2,
  66. size_t* length);
  67. #ifdef __cplusplus
  68. }
  69. #endif