feedc0de/boost_system
1
0
Fork 0
forked from boostorg/system
Code Pull Requests Activity

Minor usage section changes

Browse Source
This commit is contained in:
Peter Dimov
2021-11-11 04:33:06 +02:00
parent 0e84860604
commit 128bdf9db2
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/system/usage.adoc
View File

@ -198,7 +198,7 @@ It's possible to use system as well, as `EINVAL` is also a system category
value under POSIX; however, using the generic category for values belonging value under POSIX; however, using the generic category for values belonging
to the portable `errno` subset is slightly preferrable. to the portable `errno` subset is slightly preferrable.
Our implementation of `file::write` needs to uindergo a similar treatment. Our implementation of `file::write` needs to undergo a similar treatment.
There, however, we'll apply another change. When there's no space left on There, however, we'll apply another change. When there's no space left on
the disk, `::write` returns a number of bytes written that is lower than the disk, `::write` returns a number of bytes written that is lower than
what we requested with `size`, but our function signals no error. We'll make what we requested with `size`, but our function signals no error. We'll make
@ -297,7 +297,7 @@ std::size_t file::write( void const * buffer, std::size_t size, sys::error_code&
## Attaching a Source Location to Error Codes ## Attaching a Source Location to Error Codes
Unlike the standard `<system_error>`, Boost.System allows source locations Unlike the standard `<system_error>`, Boost.System allows source locations
(file:line:function) to be stored in `error_code`, so that functions handling (file/line/function) to be stored in `error_code`, so that functions handling
the error can display or log the source code location where the error occurred. the error can display or log the source code location where the error occurred.
To take advantage of this functionality, our POSIX `file::read` function needs To take advantage of this functionality, our POSIX `file::read` function needs
to be augmented as follows: to be augmented as follows:
@ -514,8 +514,8 @@ std::size_t file_copy( file& src, file& dest )
That is, we simply call the nonthrowing overload of `file_copy`, and if That is, we simply call the nonthrowing overload of `file_copy`, and if
it signals failure in `ec`, throw a `system_error` exception. it signals failure in `ec`, throw a `system_error` exception.
We use our function name `++__func__++` (`file_copy`) as the prefix, although We use our function name `++__func__++` (`"file_copy"`) as the prefix,
that's a matter of taste. although that's a matter of taste.
Note that typically under this style the overloads taking `error_code& ec` Note that typically under this style the overloads taking `error_code& ec`
are decorated with `noexcept`, so that it's clear that they don't throw are decorated with `noexcept`, so that it's clear that they don't throw