Migration Notes

namespace logr::detail {
struct scope_token { ~scope_token(); };
}

namespace logr {

/** Attach a key/value pair to every log line in the current scope.

    The context stays attached until the returned token is destroyed.
    Hold it in `auto`; nested contexts stack and unwind in reverse order.

    @par Example
    @code
    void handle_request(request const& req) {
        auto ctx = logr::scoped_context("request_id", req.id);
        do_work(req);
    }
    @endcode

    @param key   The context name surfaced on each log line.
    @param value The context value surfaced on each log line.
    @return An opaque RAII token whose lifetime governs how long the pair
            stays attached. The type is implementation-defined; store it
            in `auto`.
*/
detail::scope_token scoped_context(char const* key, char const* value);

}

implementation-defined:
  - 'logr::detail::**'

#if !defined(LOGR_DOCUMENTATION_BUILD)
namespace logr::detail {
struct scope_token { ~scope_token(); };
}
#endif

#include <logr/detail/scope_token.hpp>
namespace logr {
#if defined(LOGR_DOCUMENTATION_BUILD)
/** Attach a key/value pair to every log line in the current scope.

    The context stays attached until the returned token is destroyed.
    Hold it in `auto`; nested contexts stack and unwind in reverse order.

    @par Example
    @code
    void handle_request(request const& req) {
        auto ctx = logr::scoped_context("request_id", req.id);
        do_work(req);
    }
    @endcode

    @param key   The context name surfaced on each log line.
    @param value The context value surfaced on each log line.
    @return An opaque RAII token whose lifetime governs how long the pair
            stays attached. The type is implementation-defined; store it
            in `auto`.
*/
__implementation_defined__ scoped_context(char const* key, char const* value);
#else
detail::scope_token scoped_context(char const* key, char const* value);
#endif
} // namespace logr

PREDEFINED = LOGR_DOCUMENTATION_BUILD=1

namespace netz {

/** A non-owning view of a contiguous byte range.

    Used as the parameter and return type for the framing helpers in
    `netz::stream` and as the buffer surface presented to async read
    handlers. Stores a pointer and a length, and does not extend the
    lifetime of the storage it refers to.
*/
class buffer_view
{
public:
    unsigned char const* data() const noexcept;
    unsigned long size() const noexcept;
};

}

namespace netz {

/** Locate the first complete packet at the start of the buffer.

    Scans `input` for a frame boundary. The returned view aliases the
    same memory as `input`, so the storage behind `input` must outlive
    the returned view.

    @param input Bytes received from the stream, up to the caller's
                 current fill mark.
    @return A view of the bytes belonging to the first packet, or an
            empty view if no complete packet is present yet.
*/
buffer_view first_packet(buffer_view input);

}

namespace netz {
/** A non-owning view of a contiguous byte range.

    Used as the parameter and return type for the framing helpers in
    `netz::stream` and as the buffer surface presented to async read
    handlers. Stores a pointer and a length, and does not extend the
    lifetime of the storage it refers to.
*/
class buffer_view
{
public:
    unsigned char const* data() const noexcept;
    unsigned long size() const noexcept;
};
}

#include <netz/buffer_view.hpp>
namespace netz {
#if defined(NETZ_DOCUMENTATION_BUILD)
/** Locate the first complete packet at the start of the buffer.

    Scans `input` for a frame boundary. The returned view aliases the
    same memory as `input`, so the storage behind `input` must outlive
    the returned view.

    @param input Bytes received from the stream, up to the caller's
                 current fill mark.
    @return A view of the bytes belonging to the first packet, or an
            empty view if no complete packet is present yet.
*/
__see_below__ first_packet(__see_below__ input);
#else
buffer_view first_packet(buffer_view input);
#endif
} // namespace netz

PREDEFINED = NETZ_DOCUMENTATION_BUILD=1

namespace numerics {

struct clamp_fn
{
    /** Constrain a value to the inclusive range `[lo, hi]`.

        Returns `lo` when `v < lo`, `hi` when `hi < v`, otherwise `v`.
        Behavior is undefined if `hi < lo`.

        @tparam T  A type comparable with `operator<`.
        @param  v  The value to constrain.
        @param  lo The inclusive lower bound.
        @param  hi The inclusive upper bound.
        @return A copy of `v`, `lo`, or `hi`, whichever lies within the range.
    */
    template <class T>
    T operator()(T const& v, T const& lo, T const& hi) const;
};

inline constexpr clamp_fn clamp = {};

}

auto-function-objects: true

namespace numerics {
#if defined(NUMERICS_DOCUMENTATION_BUILD)
/** Constrain a value to the inclusive range `[lo, hi]`.

    Returns `lo` when `v < lo`, `hi` when `hi < v`, otherwise `v`.
    Behavior is undefined if `hi < lo`.

    @tparam T  A type comparable with `operator<`.
    @param  v  The value to constrain.
    @param  lo The inclusive lower bound.
    @param  hi The inclusive upper bound.
    @return A copy of `v`, `lo`, or `hi`, whichever lies within the range.
*/
template <class T>
T clamp(T const& v, T const& lo, T const& hi);
#else
struct clamp_fn
{
    template <class T>
    T operator()(T const& v, T const& lo, T const& hi) const;
};
inline constexpr clamp_fn clamp = {};
#endif
} // namespace numerics

PREDEFINED = NUMERICS_DOCUMENTATION_BUILD=1

namespace jzon::extra {

// Filtered out: `exclude-symbols: 'jzon::extra::**'` drops these
// symbols by qualified name, so the `jzon::extra` namespace and its
// members never enter the rendered docs.
void enable_trace();
void disable_trace();

}

namespace jzon {

/** Validate that the document is well-formed JSON.

    Parses `source` without constructing a value tree, reporting only
    whether the input conforms to RFC 8259. Comments and trailing
    commas are rejected.

    @param source A null-terminated UTF-8 JSON document.
    @return `true` if the document is syntactically valid JSON, `false`
            if any syntactic error is encountered.
*/
bool validate(char const* source);

}

exclude-symbols:
  - 'jzon::extra::**'

namespace jzon::extra {
#if !defined(JZON_DOCUMENTATION_BUILD)
void enable_trace();
void disable_trace();
#endif
} // namespace jzon::extra

namespace jzon {
/** Validate that the document is well-formed JSON.

    Parses `source` without constructing a value tree, reporting only
    whether the input conforms to RFC 8259. Comments and trailing
    commas are rejected.

    @param source A null-terminated UTF-8 JSON document.
    @return `true` if the document is syntactically valid JSON, `false`
            if any syntactic error is encountered.
*/
bool validate(char const* source);
} // namespace jzon

PREDEFINED = JZON_DOCUMENTATION_BUILD=1