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

Update indentation in reference

Browse Source
This commit is contained in:
Peter Dimov
2021-09-17 18:43:30 +03:00
parent 3f67d3def5
commit cebb011a58
1 changed files with 290 additions and 285 deletions
Download Patch File Download Diff File Expand all files Collapse all files

575
doc/system/reference.adoc
View File

@ -54,12 +54,12 @@ the old names, but will provide them when the macro `BOOST_SYSTEM_ENABLE_DEPRECA
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
template<class T> template<class T>
struct is_error_code_enum { static const bool value = false; }; struct is_error_code_enum { static const bool value = false; };
} // namespace system } // namespace system
} // namespace boost } // namespace boost
``` ```
@ -74,12 +74,12 @@ be provided in the same namespace as the enumeration type.
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
template<class T> template<class T>
struct is_error_condition_enum { static const bool value = false; }; struct is_error_condition_enum { static const bool value = false; };
} // namespace system } // namespace system
} // namespace boost } // namespace boost
``` ```
@ -94,101 +94,101 @@ should be provided in the same namespace as the enumeration type.
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
namespace errc { namespace errc {
enum errc_t enum errc_t
{ {
success = 0, success = 0,
address_family_not_supported, //EAFNOSUPPORT address_family_not_supported, //EAFNOSUPPORT
address_in_use, //EADDRINUSE address_in_use, //EADDRINUSE
address_not_available, //EADDRNOTAVAIL address_not_available, //EADDRNOTAVAIL
already_connected, //EISCONN already_connected, //EISCONN
argument_list_too_long, //E2BIG argument_list_too_long, //E2BIG
argument_out_of_domain, //EDOM argument_out_of_domain, //EDOM
bad_address, //EFAULT bad_address, //EFAULT
bad_file_descriptor, //EBADF bad_file_descriptor, //EBADF
bad_message, //EBADMSG bad_message, //EBADMSG
broken_pipe, //EPIPE broken_pipe, //EPIPE
connection_aborted, //ECONNABORTED connection_aborted, //ECONNABORTED
connection_already_in_progress, //EALREADY connection_already_in_progress, //EALREADY
connection_refused, //ECONNREFUSED connection_refused, //ECONNREFUSED
connection_reset, //ECONNRESET connection_reset, //ECONNRESET
cross_device_link, //EXDEV cross_device_link, //EXDEV
destination_address_required, //EDESTADDRREQ destination_address_required, //EDESTADDRREQ
device_or_resource_busy, //EBUSY device_or_resource_busy, //EBUSY
directory_not_empty, //ENOTEMPTY directory_not_empty, //ENOTEMPTY
executable_format_error, //ENOEXEC executable_format_error, //ENOEXEC
file_exists, //EEXIST file_exists, //EEXIST
file_too_large, //EFBIG file_too_large, //EFBIG
filename_too_long, //ENAMETOOLONG filename_too_long, //ENAMETOOLONG
function_not_supported, //ENOSYS function_not_supported, //ENOSYS
host_unreachable, //EHOSTUNREACH host_unreachable, //EHOSTUNREACH
identifier_removed, //EIDRM identifier_removed, //EIDRM
illegal_byte_sequence, //EILSEQ illegal_byte_sequence, //EILSEQ
inappropriate_io_control_operation, //ENOTTY inappropriate_io_control_operation, //ENOTTY
interrupted, //EINTR interrupted, //EINTR
invalid_argument, //EINVAL invalid_argument, //EINVAL
invalid_seek, //ESPIPE invalid_seek, //ESPIPE
io_error, //EIO io_error, //EIO
is_a_directory, //EISDIR is_a_directory, //EISDIR
message_size, //EMSGSIZE message_size, //EMSGSIZE
network_down, //ENETDOWN network_down, //ENETDOWN
network_reset, //ENETRESET network_reset, //ENETRESET
network_unreachable, //ENETUNREACH network_unreachable, //ENETUNREACH
no_buffer_space, //ENOBUFS no_buffer_space, //ENOBUFS
no_child_process, //ECHILD no_child_process, //ECHILD
no_link, //ENOLINK no_link, //ENOLINK
no_lock_available, //ENOLCK no_lock_available, //ENOLCK
no_message_available, //ENODATA no_message_available, //ENODATA
no_message, //ENOMSG no_message, //ENOMSG
no_protocol_option, //ENOPROTOOPT no_protocol_option, //ENOPROTOOPT
no_space_on_device, //ENOSPC no_space_on_device, //ENOSPC
no_stream_resources, //ENOSR no_stream_resources, //ENOSR
no_such_device_or_address, //ENXIO no_such_device_or_address, //ENXIO
no_such_device, //ENODEV no_such_device, //ENODEV
no_such_file_or_directory, //ENOENT no_such_file_or_directory, //ENOENT
no_such_process, //ESRCH no_such_process, //ESRCH
not_a_directory, //ENOTDIR not_a_directory, //ENOTDIR
not_a_socket, //ENOTSOCK not_a_socket, //ENOTSOCK
not_a_stream, //ENOSTR not_a_stream, //ENOSTR
not_connected, //ENOTCONN not_connected, //ENOTCONN
not_enough_memory, //ENOMEM not_enough_memory, //ENOMEM
not_supported, //ENOTSUP not_supported, //ENOTSUP
operation_canceled, //ECANCELED operation_canceled, //ECANCELED
operation_in_progress, //EINPROGRESS operation_in_progress, //EINPROGRESS
operation_not_permitted, //EPERM operation_not_permitted, //EPERM
operation_not_supported, //EOPNOTSUPP operation_not_supported, //EOPNOTSUPP
operation_would_block, //EWOULDBLOCK operation_would_block, //EWOULDBLOCK
owner_dead, //EOWNERDEAD owner_dead, //EOWNERDEAD
permission_denied, //EACCES permission_denied, //EACCES
protocol_error, //EPROTO protocol_error, //EPROTO
protocol_not_supported, //EPROTONOSUPPORT protocol_not_supported, //EPROTONOSUPPORT
read_only_file_system, //EROFS read_only_file_system, //EROFS
resource_deadlock_would_occur, //EDEADLK resource_deadlock_would_occur, //EDEADLK
resource_unavailable_try_again, //EAGAIN resource_unavailable_try_again, //EAGAIN
result_out_of_range, //ERANGE result_out_of_range, //ERANGE
state_not_recoverable, //ENOTRECOVERABLE state_not_recoverable, //ENOTRECOVERABLE
stream_timeout, //ETIME stream_timeout, //ETIME
text_file_busy, //ETXTBSY text_file_busy, //ETXTBSY
timed_out, //ETIMEDOUT timed_out, //ETIMEDOUT
too_many_files_open_in_system, //ENFILE too_many_files_open_in_system, //ENFILE
too_many_files_open, //EMFILE too_many_files_open, //EMFILE
too_many_links, //EMLINK too_many_links, //EMLINK
too_many_synbolic_link_levels, //ELOOP too_many_synbolic_link_levels, //ELOOP
value_too_large, //EOVERFLOW value_too_large, //EOVERFLOW
wrong_protocol_type //EPROTOTYPE wrong_protocol_type //EPROTOTYPE
}; };
} // namespace errc } // namespace errc
template<> struct is_error_condition_enum<errc::errc_t> template<> struct is_error_condition_enum<errc::errc_t>
{ static const bool value = true; }; { static const bool value = true; };
constexpr error_code make_error_code( errc::errc_t e ) noexcept; constexpr error_code make_error_code( errc::errc_t e ) noexcept;
constexpr error_condition make_error_condition( errc::errc_t e ) noexcept; constexpr error_condition make_error_condition( errc::errc_t e ) noexcept;
} // namespace system } // namespace system
} // namespace boost } // namespace boost
``` ```
@ -268,56 +268,56 @@ errors in addition to those defined in Boost.System.
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
class error_category class error_category
{ {
public: // noncopyable public: // noncopyable
error_category( error_category const & ) = delete; error_category( error_category const & ) = delete;
error_category& operator=( error_category const & ) = delete; error_category& operator=( error_category const & ) = delete;
protected: protected:
~error_category() = default; ~error_category() = default;
constexpr error_category() noexcept; constexpr error_category() noexcept;
explicit constexpr error_category( unsigned long long id ) noexcept; explicit constexpr error_category( unsigned long long id ) noexcept;
public: public:
virtual const char * name() const noexcept = 0; virtual const char * name() const noexcept = 0;
virtual error_condition default_error_condition( int ev ) const noexcept; virtual error_condition default_error_condition( int ev ) const noexcept;
virtual bool equivalent( int code, const error_condition & condition ) virtual bool equivalent( int code, const error_condition & condition )
const noexcept; const noexcept;
virtual bool equivalent( const error_code & code, int condition ) virtual bool equivalent( const error_code & code, int condition )
const noexcept; const noexcept;
virtual std::string message( int ev ) const = 0; virtual std::string message( int ev ) const = 0;
virtual char const * message( int ev, char * buffer, std::size_t len ) virtual char const * message( int ev, char * buffer, std::size_t len )
const noexcept; const noexcept;
virtual bool failed( int ev ) const noexcept; virtual bool failed( int ev ) const noexcept;
friend constexpr bool operator==( const error_category & lhs, friend constexpr bool operator==( const error_category & lhs,
const error_category & rhs ) noexcept; const error_category & rhs ) noexcept;
friend constexpr bool operator!=( const error_category & lhs, friend constexpr bool operator!=( const error_category & lhs,
const error_category & rhs ) noexcept; const error_category & rhs ) noexcept;
friend constexpr bool operator< ( const error_category & lhs, friend constexpr bool operator< ( const error_category & lhs,
const error_category & rhs ) noexcept; const error_category & rhs ) noexcept;
operator std::error_category const & () const; operator std::error_category const & () const;
private: private:
unsigned long long id_; // exposition only unsigned long long id_; // exposition only
};
}; } // namespace system
} } // namespace boost
}
``` ```
#### Constructors #### Constructors
@ -422,20 +422,24 @@ Example: ::
``` ```
const char* my_category::message(int ev, char* buffer, size_t len) const noexcept const char* my_category::message(int ev, char* buffer, size_t len) const noexcept
{ {
switch(ev) switch(ev)
{ {
case 0: return "no error"; case 0: return "no error";
case 1: return "voltage out of range"; case 1: return "voltage out of range";
case 2: return "impedance mismatch"; case 2: return "impedance mismatch";
case 31:
case 32: case 31:
case 33: case 32:
std::snprintf(buffer, len, "component %d failure", ev-30); case 33:
return buffer;
default: std::snprintf(buffer, len, "component %d failure", ev-30);
std::snprintf(buffer, len, "unknown error %d", ev); return buffer;
return buffer;
} default:
std::snprintf(buffer, len, "unknown error %d", ev);
return buffer;
}
} }
``` ```
@ -503,11 +507,11 @@ Returns: :: A reference to an `std::error_category` object corresponding
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
constexpr const error_category & system_category() noexcept; constexpr const error_category & system_category() noexcept;
} // namespace system } // namespace system
} // namespace boost } // namespace boost
``` ```
@ -526,11 +530,11 @@ Returns: :: A reference to a predefined `error_category` object identifying
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
constexpr const error_category & generic_category() noexcept; constexpr const error_category & generic_category() noexcept;
} // namespace system } // namespace system
} // namespace boost } // namespace boost
``` ```
@ -554,116 +558,116 @@ by exception.
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
class error_code { class error_code {
public: public:
// constructors: // constructors
constexpr error_code() noexcept; constexpr error_code() noexcept;
constexpr error_code( int val, const error_category & cat ) noexcept; constexpr error_code( int val, const error_category & cat ) noexcept;
error_code( int val, const error_category & cat, error_code( int val, const error_category & cat,
boost::source_location const * loc ) noexcept; boost::source_location const * loc ) noexcept;
template <class ErrorCodeEnum> template <class ErrorCodeEnum>
constexpr error_code( ErrorCodeEnum e ) noexcept; constexpr error_code( ErrorCodeEnum e ) noexcept;
error_code( std::error_code const& ec ) noexcept; error_code( std::error_code const& ec ) noexcept;
// modifiers: // modifiers
constexpr void assign( int val, const error_category & cat ) noexcept; constexpr void assign( int val, const error_category & cat ) noexcept;
void assign( int val, const error_category & cat, void assign( int val, const error_category & cat,
boost::source_location const * loc ) noexcept; boost::source_location const * loc ) noexcept;
template<typename ErrorCodeEnum> template<typename ErrorCodeEnum>
constexpr error_code & operator=( ErrorCodeEnum e ) noexcept; constexpr error_code & operator=( ErrorCodeEnum e ) noexcept;
constexpr void clear() noexcept; constexpr void clear() noexcept;
// observers: // observers
constexpr int value() const noexcept; constexpr int value() const noexcept;
constexpr const error_category & category() const noexcept; constexpr const error_category & category() const noexcept;
error_condition default_error_condition() const noexcept; error_condition default_error_condition() const noexcept;
std::string message() const; std::string message() const;
char const * message( char * buffer, std::size_t len ) const noexcept; char const * message( char * buffer, std::size_t len ) const noexcept;
constexpr bool failed() const noexcept; constexpr bool failed() const noexcept;
constexpr explicit operator bool() const noexcept; constexpr explicit operator bool() const noexcept;
bool has_location() const noexcept; bool has_location() const noexcept;
boost::source_location const & location() const noexcept; boost::source_location const & location() const noexcept;
// comparisons: // comparisons
friend constexpr bool operator==( const error_code & lhs, friend constexpr bool operator==( const error_code & lhs,
const error_code & rhs ) noexcept; const error_code & rhs ) noexcept;
friend constexpr bool operator!=( const error_code & lhs, friend constexpr bool operator!=( const error_code & lhs,
const error_code & rhs ) noexcept; const error_code & rhs ) noexcept;
friend constexpr bool operator<( const error_code & lhs, friend constexpr bool operator<( const error_code & lhs,
const error_code & rhs ) noexcept; const error_code & rhs ) noexcept;
friend bool operator==( const error_code & code, friend bool operator==( const error_code & code,
const error_condition & condition ) noexcept; const error_condition & condition ) noexcept;
friend bool operator==( const error_condition & condition, friend bool operator==( const error_condition & condition,
const error_code & code ) noexcept; const error_code & code ) noexcept;
friend bool operator!=( const error_code & code, friend bool operator!=( const error_code & code,
const error_condition & condition ) noexcept; const error_condition & condition ) noexcept;
friend bool operator!=( const error_condition & condition, friend bool operator!=( const error_condition & condition,
const error_code & code ) noexcept; const error_code & code ) noexcept;
friend bool operator==( const error_code & lhs, friend bool operator==( const error_code & lhs,
const std::error_code & rhs ) noexcept; const std::error_code & rhs ) noexcept;
friend bool operator==( const std::error_code & lhs, friend bool operator==( const std::error_code & lhs,
const error_code & rhs ) noexcept; const error_code & rhs ) noexcept;
friend bool operator!=( const error_code & lhs, friend bool operator!=( const error_code & lhs,
const std::error_code & rhs ) noexcept; const std::error_code & rhs ) noexcept;
friend bool operator!=( const std::error_code & lhs, friend bool operator!=( const std::error_code & lhs,
const error_code & rhs ) noexcept; const error_code & rhs ) noexcept;
template<class E> template<class E>
friend constexpr bool operator==( const error_code & lhs, E rhs ) noexcept; friend constexpr bool operator==( const error_code & lhs, E rhs ) noexcept;
template<class E> template<class E>
friend constexpr bool operator==( E lhs, const error_code & rhs ) noexcept; friend constexpr bool operator==( E lhs, const error_code & rhs ) noexcept;
template<class E> template<class E>
friend constexpr bool operator!=( const error_code & lhs, E rhs ) noexcept; friend constexpr bool operator!=( const error_code & lhs, E rhs ) noexcept;
template<class E> template<class E>
friend constexpr bool operator!=( E lhs, const error_code & rhs ) noexcept; friend constexpr bool operator!=( E lhs, const error_code & rhs ) noexcept;
// conversions: // conversions
operator std::error_code() const; operator std::error_code() const;
operator std::error_code(); operator std::error_code();
template<class T> operator T& (); // only when T=std::error_code template<class T> operator T& (); // only when T=std::error_code
// to_string // to_string
std::string to_string() const; std::string to_string() const;
// stream insertion: // stream insertion
template <class charT, class traits> template <class charT, class traits>
std::basic_ostream<charT, traits>& friend std::basic_ostream<charT, traits>&
operator<<( basic_ostream<charT, traits>& os, const error_code & ec ); operator<<( basic_ostream<charT, traits>& os, const error_code & ec );
}; };
// non-member functions // non-member functions
std::size_t hash_value( const error_code & ec ); std::size_t hash_value( const error_code & ec );
} } // namespace system
} } // namespace boost
``` ```
#### Constructors #### Constructors
@ -1034,72 +1038,73 @@ Returns: :: If `ec` wraps a `std::error_code` object `e2`, `std::hash<std::error
``` ```
namespace boost { namespace boost {
namespace system { namespace system {
class error_condition { class error_condition {
public: public:
// constructors: // constructors
constexpr error_condition() noexcept; constexpr error_condition() noexcept;
constexpr error_condition( int val, const error_category & cat ) noexcept; constexpr error_condition( int val, const error_category & cat ) noexcept;
template <class ErrorConditionEnum> template <class ErrorConditionEnum>
constexpr error_condition( ErrorConditionEnum e ) noexcept; constexpr error_condition( ErrorConditionEnum e ) noexcept;
// modifiers: // modifiers
constexpr void assign( int val, const error_category & cat ) noexcept; constexpr void assign( int val, const error_category & cat ) noexcept;
template<typename ErrorConditionEnum> template<typename ErrorConditionEnum>
constexpr error_condition & operator=( ErrorConditionEnum e ) noexcept; constexpr error_condition & operator=( ErrorConditionEnum e ) noexcept;
constexpr void clear() noexcept; constexpr void clear() noexcept;
// observers: // observers
constexpr int value() const noexcept; constexpr int value() const noexcept;
constexpr const error_category & category() const noexcept; constexpr const error_category & category() const noexcept;
std::string message() const; std::string message() const;
char const * message( char * buffer, std::size_t len ) const noexcept; char const * message( char * buffer, std::size_t len ) const noexcept;
constexpr bool failed() const noexcept; constexpr bool failed() const noexcept;
constexpr explicit operator bool() const noexcept; constexpr explicit operator bool() const noexcept;
// comparisons: // comparisons
friend constexpr bool operator==( const error_condition & lhs, friend constexpr bool operator==( const error_condition & lhs,
const error_condition & rhs ) noexcept; const error_condition & rhs ) noexcept;
friend constexpr bool operator!=( const error_condition & lhs, friend constexpr bool operator!=( const error_condition & lhs,
const error_condition & rhs ) noexcept; const error_condition & rhs ) noexcept;
friend constexpr bool operator<( const error_condition & lhs, friend constexpr bool operator<( const error_condition & lhs,
const error_condition & rhs ) noexcept; const error_condition & rhs ) noexcept;
friend bool operator==( const std::error_code & code, friend bool operator==( const std::error_code & code,
const error_condition & condition ) noexcept; const error_condition & condition ) noexcept;
friend bool operator==( const error_condition & condition, friend bool operator==( const error_condition & condition,
const std::error_code & code ) noexcept; const std::error_code & code ) noexcept;
friend bool operator!=( const std::error_code & code, friend bool operator!=( const std::error_code & code,
const error_condition & condition ) noexcept; const error_condition & condition ) noexcept;
friend bool operator!=( const error_condition & condition, friend bool operator!=( const error_condition & condition,
const std::error_code & code ) noexcept; const std::error_code & code ) noexcept;
// conversions: // conversions
operator std::error_condition() const; operator std::error_condition() const;
// stream insertion: // stream insertion
template <class charT, class traits> template <class charT, class traits>
std::basic_ostream<charT, traits>& friend std::basic_ostream<charT, traits>&
operator<<( basic_ostream<charT, traits>& os, const error_condition & en ); operator<<( basic_ostream<charT, traits>& os, const error_condition & en );
}; };
}
} } // namespace system
} // namespace boost
``` ```
#### Constructors #### Constructors
@ -1295,7 +1300,7 @@ Returns: ::
## <boost/system/{zwsp}system_error.hpp> ## <boost/system/{zwsp}system_error.hpp>
### Class system_error ### system_error
The class `system_error` describes an exception object used to The class `system_error` describes an exception object used to
report errors that have an associated `error_code`. Such errors report errors that have an associated `error_code`. Such errors
@ -1303,29 +1308,29 @@ typically originate from operating system or other low-level
application program interfaces. application program interfaces.
``` ```
namespace boost namespace boost {
namespace system {
class system_error: public std::runtime_error
{ {
namespace system public:
{
class system_error: public std::runtime_error
{
public:
explicit system_error( error_code ec ); explicit system_error( error_code ec );
system_error( error_code ec, const char * what_arg ); system_error( error_code ec, const char * what_arg );
system_error( error_code ec, const std::string & what_arg ); system_error( error_code ec, const std::string & what_arg );
system_error( int ev, const error_category & ecat ); system_error( int ev, const error_category & ecat );
system_error( int ev, const error_category & ecat, system_error( int ev, const error_category & ecat,
const char * what_arg ); const char * what_arg );
system_error( int ev, const error_category & ecat, system_error( int ev, const error_category & ecat,
const std::string & what_arg ); const std::string & what_arg );
error_code code() const noexcept; error_code code() const noexcept;
const char * what() const noexcept; const char * what() const noexcept;
}; };
}
} } // namespace system
} // namespace boost
``` ```
#### Constructors #### Constructors