libs/beast/doc/qbk/03_core/8_conf_macros.qbk

   1 [/
   2     Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
   3
   4     Distributed under the Boost Software License, Version 1.0. (See accompanying
   5     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6
   7     Official repository: https://github.com/boostorg/beast
   8 ]
   9
  10 [section Configuration preprocessor definitions]
  11
  12 A number of configuration preprocessor definitions can be used to change
  13 the behavior of Beast.
  14 The user should assume that they introduce significant changes to the public part
  15 of this library's API and make sure that all translation units (usually files)
  16 compiled and linked into a program use the same combination of configuration macros,
  17 failure to do so may result in violations of ODR (One Definition Rule).
  18
  19 [table Special Fields
  20 [[Definition][Description]]
  21 [
  22     [
  23         BOOST_BEAST_USE_STD_STRING_VIEW
  24     ][
  25         Causes Beast to use std::string_view instead of boost::string_view.
  26         Requires C++17.
  27     ]
  28 ]
  29 [
  30     [
  31         BOOST_BEAST_SEPARATE_COMPILATION
  32     ][
  33         Enables the split compilation mode, which allows the user to compile
  34         definitions of non-template entities in a single translation unit, thus
  35         improving compilation speed. That translation unit has to include
  36         boost/beast/src.hpp in order to compile the definitions.
  37     ]
  38 ]
  39 [
  40     [
  41         BOOST_BEAST_ALLOW_DEPRECATED
  42     ][
  43         Enables the use of deprecated APIs within Beast.
  44     ]
  45 ]
  46 ]