codec_flags.hxx File Reference

#include <cinttypes>
#include <vector>

Include dependency graph for codec_flags.hxx:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	couchbase
	Represents a single item from the result of collection::scan()
namespace	couchbase::codec
namespace	couchbase::codec::codec_flags

Enumerations
enum class	common_flags : std::uint32_t {   reserved = 0x00 , client_specific = 0x01 , json = 0x02 , binary = 0x03 ,   string = 0x04 }

Functions
constexpr auto	create_common_flags (common_flags flags) -> std::uint32_t
	Takes a enum representation of common flags and moves them to the common flags MSBs.
constexpr auto	extract_common_flags (std::uint32_t flags) -> common_flags
	Returns only the common flags from the full flags.
constexpr auto	has_common_flags (std::uint32_t flags) -> bool
	Checks whether the upper 8 bits are set, indicating common flags presence.
constexpr auto	has_common_flags (std::uint32_t flags, std::uint32_t expected_common_flag) -> bool
	Checks that flags has common flags bits set and that they correspond to expected common flags format.
constexpr auto	has_common_flags (std::uint32_t flags, common_flags expected_common_flag) -> bool
	Checks that flags has common flags bits set and that they correspond to expected common flags value.
constexpr auto	has_compression_flags (std::uint32_t flags) -> bool
	Checks whether the upper 3 bits are set, indicating compression presence.

Variables
constexpr std::uint32_t	common_format_mask = 0x0F000000
	32bit flag is composed of:
constexpr std::uint32_t	private_common_flags = create_common_flags(common_flags::client_specific)
constexpr std::uint32_t	json_common_flags = create_common_flags(common_flags::json)
constexpr std::uint32_t	binary_common_flags = create_common_flags(common_flags::binary)
constexpr std::uint32_t	string_common_flags = create_common_flags(common_flags::string)