prism/c/buffer_8hpp_source.html

#ifndef PRISM_BUFFER_HPP

#define PRISM_BUFFER_HPP


#include "prism/compiler/cplusplus.hpp"

#include "prism/compiler/lifetimebound.hpp"


#include "prism/buffer.h"


#include <memory>

#include <string_view>


namespace prism {


struct buffer_deleter {

    void operator()(pm_buffer_t *buffer) const noexcept { pm_buffer_free(buffer); }

};


using unique_buffer = std::unique_ptr<pm_buffer_t, buffer_deleter>;


[[nodiscard]] inline unique_buffer


make_buffer() noexcept {

    return unique_buffer(pm_buffer_new());

}


[[nodiscard]] inline std::string_view


view(const pm_buffer_t *buffer PRISM_LIFETIMEBOUND) noexcept {

    return std::string_view(pm_buffer_value(buffer), pm_buffer_length(buffer));

}


}


#endif

buffer.h
A wrapper around a contiguous block of allocated memory.

pm_buffer_t
struct pm_buffer_t pm_buffer_t
A wrapper around a contiguous block of allocated memory.
Definition buffer.h:22

pm_buffer_new
PRISM_NODISCARD PRISM_EXPORTED_FUNCTION pm_buffer_t * pm_buffer_new(void)
Allocate and initialize a new buffer.

pm_buffer_length
PRISM_EXPORTED_FUNCTION size_t pm_buffer_length(const pm_buffer_t *buffer) PRISM_NONNULL(1)
Return the length of the buffer.

pm_buffer_value
PRISM_EXPORTED_FUNCTION char * pm_buffer_value(const pm_buffer_t *buffer) PRISM_NONNULL(1)
Return the value of the buffer.

pm_buffer_free
PRISM_EXPORTED_FUNCTION void pm_buffer_free(pm_buffer_t *buffer) PRISM_NONNULL(1)
Free both the memory held by the buffer and the buffer itself.

prism::make_buffer
unique_buffer make_buffer() noexcept
Allocate a new empty buffer.
Definition buffer.hpp:38

prism::unique_buffer
std::unique_ptr< pm_buffer_t, buffer_deleter > unique_buffer
An owned buffer.
Definition buffer.hpp:30

prism::view
std::string_view view(const pm_buffer_t *buffer) noexcept
The bytes written to the given buffer so far.
Definition buffer.hpp:49

prism::buffer_deleter
Frees a buffer with pm_buffer_free.
Definition buffer.hpp:20

prism::buffer_deleter::operator()
void operator()(pm_buffer_t *buffer) const noexcept
Frees the given buffer.
Definition buffer.hpp:26