nlohmann::byte_container_with_subtype
BinaryType
json.hpp
typename BinaryType
BinaryType using nlohmann::byte_container_with_subtype< BinaryType >::container_type = BinaryType container_type

the type of the underlying container

std::uint8_t std::uint8_t nlohmann::byte_container_with_subtype< BinaryType >::m_subtype m_subtype = 0 nlohmann::byte_container_with_subtype< BinaryType >::operator==
bool bool nlohmann::byte_container_with_subtype< BinaryType >::m_has_subtype m_has_subtype = false nlohmann::byte_container_with_subtype< BinaryType >::operator==
nlohmann::byte_container_with_subtype< BinaryType >::byte_container_with_subtype
() noexcept(noexcept(container_type()))
byte_container_with_subtype
nlohmann::byte_container_with_subtype< BinaryType >::byte_container_with_subtype
(const container_type &b) noexcept(noexcept(container_type(b)))
byte_container_with_subtype
const container_type & b
nlohmann::byte_container_with_subtype< BinaryType >::byte_container_with_subtype
(container_type &&b) noexcept(noexcept(container_type(std::move(b))))
byte_container_with_subtype
container_type && b
nlohmann::byte_container_with_subtype< BinaryType >::byte_container_with_subtype
(const container_type &b, std::uint8_t subtype_) noexcept(noexcept(container_type(b)))
byte_container_with_subtype
const container_type & b
std::uint8_t subtype_
nlohmann::byte_container_with_subtype< BinaryType >::byte_container_with_subtype
(container_type &&b, std::uint8_t subtype_) noexcept(noexcept(container_type(std::move(b))))
byte_container_with_subtype
container_type && b
std::uint8_t subtype_
bool bool nlohmann::byte_container_with_subtype< BinaryType >::operator== (const byte_container_with_subtype &rhs) const operator== const byte_container_with_subtype & rhs nlohmann::byte_container_with_subtype< BinaryType >::m_has_subtype nlohmann::byte_container_with_subtype< BinaryType >::m_subtype
bool bool nlohmann::byte_container_with_subtype< BinaryType >::operator!= (const byte_container_with_subtype &rhs) const operator!= const byte_container_with_subtype & rhs
void void nlohmann::byte_container_with_subtype< BinaryType >::set_subtype (std::uint8_t subtype_) noexcept set_subtype std::uint8_t subtype_

sets the binary subtype

Sets the binary subtype of the value, also flags a binary JSON value as having a subtype, which has implications for serialization.

Constant.

No-throw guarantee: this member function never throws exceptions.

see subtype() return the binary subtype

see clear_subtype() clears the binary subtype

see has_subtype() returns whether or not the binary value has a subtype

version 3.8.0

constexpr std::uint8_t constexpr std::uint8_t nlohmann::byte_container_with_subtype< BinaryType >::subtype () const noexcept subtype

return the binary subtype

Returns the numerical subtype of the value if it has a subtype. If it does not have a subtype, this function will return size_t(-1) as a sentinel value.

the numerical subtype of the binary value

Constant.

No-throw guarantee: this member function never throws exceptions.

see set_subtype() sets the binary subtype

see clear_subtype() clears the binary subtype

see has_subtype() returns whether or not the binary value has a subtype

version 3.8.0

constexpr bool constexpr bool nlohmann::byte_container_with_subtype< BinaryType >::has_subtype () const noexcept has_subtype

return whether the value has a subtype

whether the value has a subtype

Constant.

No-throw guarantee: this member function never throws exceptions.

see subtype() return the binary subtype

see set_subtype() sets the binary subtype

see clear_subtype() clears the binary subtype

version 3.8.0

void void nlohmann::byte_container_with_subtype< BinaryType >::clear_subtype () noexcept clear_subtype

clears the binary subtype

Clears the binary subtype and flags the value as not having a subtype, which has implications for serialization; for instance MessagePack will prefer the bin family over the ext family.

Constant.

No-throw guarantee: this member function never throws exceptions.

see subtype() return the binary subtype

see set_subtype() sets the binary subtype

see has_subtype() returns whether or not the binary value has a subtype

version 3.8.0

an internal type for a backed binary type

This type extends the template parameter BinaryType provided to `basic_json` with a subtype used by BSON and MessagePack. This type exists so that the user does not have to specify a type themselves with a specific naming scheme in order to override the binary type.

BinaryType

container to store bytes (`std::vector<std::uint8_t>` by default)

version 3.8.0

BinaryType
nlohmann::byte_container_with_subtype< BinaryType >
BinaryType
uint8_t
bool
nlohmann::byte_container_with_subtype< BinaryType >
-m_subtype
-m_has_subtype
- nlohmann::byte_container_with_subtype
  byte_container_with_subtype
- nlohmann::byte_container_with_subtype
  byte_container_with_subtype
- nlohmann::byte_container_with_subtype
  byte_container_with_subtype
- nlohmann::byte_container_with_subtype
  byte_container_with_subtype
- nlohmann::byte_container_with_subtype
  byte_container_with_subtype
- nlohmann::byte_container_with_subtype
  clear_subtype
- nlohmann::byte_container_with_subtype
  container_type
- nlohmann::byte_container_with_subtype
  has_subtype
- nlohmann::byte_container_with_subtype
  m_has_subtype
- nlohmann::byte_container_with_subtype
  m_subtype
- nlohmann::byte_container_with_subtype
  operator!=
- nlohmann::byte_container_with_subtype
  operator==
- nlohmann::byte_container_with_subtype
  set_subtype
- nlohmann::byte_container_with_subtype
  subtype