codec_flags.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2020-Present Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#pragma once
 
#include <cinttypes>
 
namespace couchbase::codec::codec_flags
{

constexpr std::uint32_t common_format_mask = 0x0F000000;
 
enum class common_flags : std::uint32_t {
  reserved = 0x00,
  client_specific = 0x01, // called PRIVATE in RFC and other SDKs
  json = 0x02,
  binary = 0x03,
  string = 0x04
};

constexpr auto
create_common_flags(common_flags flags) -> std::uint32_t
{
  return static_cast<std::uint32_t>(flags) << 24U;
}

constexpr auto
extract_common_flags(std::uint32_t flags) -> common_flags
{
  switch (auto value = static_cast<common_flags>(flags >> 24U)) {
    case common_flags::client_specific:
    case common_flags::json:
    case common_flags::binary:
    case common_flags::string:
      return value;
    default:
      break;
  }
  return common_flags::reserved;
}

constexpr auto
has_common_flags(std::uint32_t flags) -> bool
{
  return extract_common_flags(flags) != common_flags::reserved;
}

constexpr auto
has_common_flags(std::uint32_t flags, std::uint32_t expected_common_flag) -> bool
{
  return has_common_flags(flags) && (flags & common_format_mask) == expected_common_flag;
}

constexpr auto
has_common_flags(std::uint32_t flags, common_flags expected_common_flag) -> bool
{
  return has_common_flags(flags) &&
         (flags & common_format_mask) == create_common_flags(expected_common_flag);
}

constexpr auto
has_compression_flags(std::uint32_t flags) -> bool
{
  return (flags >> 29U) > 0;
}
 
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);
} // namespace couchbase::codec::codec_flags