boost_beast/doc/concept/Body.qbk

[/
    Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)

    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
]

[section:Body Body]

A [*Body] type is supplied as a template argument to the __message__ class. It
controls both the type of the data member of the resulting message object, and
the algorithms used during parsing and serialization.

In this table:

* `X` is a type meeting the requirements of [*Body].

[table Body requirements
[[expression] [type] [semantics, pre/post-conditions]]
[
    [`X::value_type`]
    []
    [
        The type of the `message::body` member.
        If this is not movable or not copyable, the containing message
        will be not movable or not copyable.
    ]
]
[
    [`X::writer`]
    []
    [
        If present, indicates that the body can hold a message body
        parsing result. The type must meet the requirements of
        __BodyWriter__. The implementation constructs an object of
        this type to obtain buffers into which parsed body octets
        are placed.
    ]
]
[
    [`X::reader`]
    []
    [
        If present, indicates that the body is serializable. The type
        must meet the requirements of __BodyReader__. The implementation
        constructs an object of this type to obtain buffers representing
        the message body for serialization.
    ]
]
[
    [`is_body<X>`]
    [`std::true_type`]
    [
        An alias for `std::true_type` for `X`, otherwise an alias
        for `std::false_type`.
    ]
]
]

[endsect]