6_files.qbk 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. [/
  2. Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
  3. Distributed under the Boost Software License, Version 1.0. (See accompanying
  4. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  5. Official repository: https://github.com/boostorg/beast
  6. ]
  7. [section Files]
  8. Often when implementing network algorithms such as servers, it is necessary
  9. to interact with files on the system. Beast defines the __File__ concept
  10. and several models to facilitate cross-platform interaction with the
  11. underlying filesystem:
  12. [table File Types
  13. [[Name][Description]]
  14. [[
  15. [link beast.ref.boost__beast__file `file`]
  16. ][
  17. `file` is a type alias to one of the following implementations,
  18. depending on what is available on the target platform.
  19. ]]
  20. [[
  21. [link beast.ref.boost__beast__file_stdio `file_stdio`]
  22. ][
  23. This implementation of __File__ uses the C++ standard library
  24. facilities obtained by including `<cstdio>`.
  25. ]]
  26. [[
  27. [link beast.ref.boost__beast__file_win32 `file_win32`]
  28. ][
  29. This implements a __File__ for the Win32 API. It provides low level
  30. access to the native file handle when necessary.
  31. ]]
  32. [[
  33. [link beast.ref.boost__beast__file_posix `file_posix`]
  34. ][
  35. For POSIX systems, this class provides a suitable implementation
  36. of __File__ which wraps the native file descriptor and provides
  37. it if necessary.
  38. ]]
  39. ]
  40. [endsect]