File

The [*File] concept abstracts access to files in the underlying file system. To support other platform interfaces, users may author their own [*File] types which meet these requirements.

Associated Types

* [link beast.ref.boost__beast__file_mode `file_mode`]
* [link beast.ref.boost__beast__is_file `is_file`]

Requirements

In this table:

* `F` is a [*File] type
* `f` is an instance of `F`
* `p` is a value of type `char const*` which points to a null

* `m` is an instance of [link beast.ref.boost__beast__file_mode `file_mode`]
* `n` is a number of bytes, convertible to `std::size_t`
* `o` is a byte offset in the file, convertible to `std::uint64_t`
* `b` is any non-const pointer to memory
* `c` is any possibly-const pointer to memory
* `ec` is a reference of type [link beast.ref.boost__beast__error_code `error_code`]

Valid expressions

Expression

Type

Semantics, Pre/Post-conditions

Operation

Return Type

`F()`

Default constructable

`f.~F()`

Destructible. If `f` refers to an open file, it is first closed as if by a call to `close` with the error ignored.

`f.is_open()`

`bool`