Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the master branch, built from commit c89e626766.
PrevUpHomeNext

http::basic_file_body

A message body represented by a file on the filesystem.

Synopsis

Defined in header <boost/beast/http/basic_file_body.hpp>

template<
    class File>
struct basic_file_body
Types

Name

Description

file_type

The type of File this body uses.

reader

Algorithm for storing buffers when parsing.

value_type

The type of the message::body member.

writer

Algorithm for retrieving buffers when serializing.

Static Member Functions

Name

Description

size

Returns the size of the body.

Description

Messages with this type have bodies represented by a file on the file system. When parsing a message using this body type, the data is stored in the file pointed to by the path, which must be writable. When serializing, the implementation will read the file and present those octets as the body content. This may be used to serve content from a directory as part of a web service.

Template Parameters

Type

Description

File

The implementation to use for accessing files. This type must meet the requirements of File.


PrevUpHomeNext