StormByte-System 3.0.0
C++26 process and environment module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::System Namespace Reference

System module of the StormByte suite. More...

Namespaces

namespace  Directory
 Directory locations of this process or user.
namespace  File
 File locations of this process.
namespace  Host
 Identity and capacity of this machine.
namespace  ThisThread
 Calling-thread helpers (the current thread, not a child process).

Classes

class  Device
 Query object for the medium behind a filesystem accessor. More...
struct  _EoF
 Tag type to close process stdin (write end). More...
class  Process
 Runs an external program with piped stdin/stdout/stderr. More...
class  Variable
 Environment variable expansion helpers. More...

Functions

const StormByte::Error::Category< Device::Error > & device_category () noexcept
 Category singleton for Device::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (Device::Error e) noexcept
 Builds an std::error_code from Device::Error.
const StormByte::Error::Category< Directory::Error > & directory_category () noexcept
 Category singleton for Directory::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (Directory::Error e) noexcept
 Builds an std::error_code from Directory::Error.
const StormByte::Error::Category< File::Error > & file_category () noexcept
 Category singleton for File::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (File::Error e) noexcept
 Builds an std::error_code from File::Error.
const StormByte::Error::Category< Host::Error > & host_category () noexcept
 Category singleton for Host::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (Host::Error e) noexcept
 Builds an std::error_code from Host::Error.
const StormByte::Error::Category< Process::Error > & process_category () noexcept
 Category singleton for Process::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (Process::Error e) noexcept
 Builds an std::error_code from Process::Error.
const StormByte::Error::Category< ThisThread::Error > & this_thread_category () noexcept
 Category singleton for ThisThread::Error.
STORMBYTE_FORCE_INLINE std::error_code make_error_code (ThisThread::Error e) noexcept
 Builds an std::error_code from ThisThread::Error.

Variables

static constexpr const _EoF EoF = {}
 Sentinel used as process << System::EoF to close stdin.

Detailed Description

System module of the StormByte suite.

Function Documentation

◆ device_category()

const StormByte::Error::Category< Device::Error > & StormByte::System::device_category ( )
noexcept

Category singleton for Device::Error.

Returns
Process-wide Device category.

◆ directory_category()

const StormByte::Error::Category< Directory::Error > & StormByte::System::directory_category ( )
noexcept

Category singleton for Directory::Error.

Returns
Process-wide Directory category.

◆ file_category()

const StormByte::Error::Category< File::Error > & StormByte::System::file_category ( )
noexcept

Category singleton for File::Error.

Returns
Process-wide File category.

◆ host_category()

const StormByte::Error::Category< Host::Error > & StormByte::System::host_category ( )
noexcept

Category singleton for Host::Error.

Returns
Process-wide Host category.

◆ make_error_code() [1/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( Device::Error e)
noexcept

Builds an std::error_code from Device::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in device_category().

◆ make_error_code() [2/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( Directory::Error e)
noexcept

Builds an std::error_code from Directory::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in directory_category().

◆ make_error_code() [3/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( File::Error e)
noexcept

Builds an std::error_code from File::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in file_category().

◆ make_error_code() [4/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( Host::Error e)
noexcept

Builds an std::error_code from Host::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in host_category().

◆ make_error_code() [5/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( Process::Error e)
noexcept

Builds an std::error_code from Process::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in process_category().

◆ make_error_code() [6/6]

STORMBYTE_FORCE_INLINE std::error_code StormByte::System::make_error_code ( ThisThread::Error e)
noexcept

Builds an std::error_code from ThisThread::Error.

Header-only: a std:: object is not a DLL return.

Parameters
eEnumerator.
Returns
Code in this_thread_category().

◆ process_category()

const StormByte::Error::Category< Process::Error > & StormByte::System::process_category ( )
noexcept

Category singleton for Process::Error.

Returns
Process-wide Process category.

◆ this_thread_category()

const StormByte::Error::Category< ThisThread::Error > & StormByte::System::this_thread_category ( )
noexcept

Category singleton for ThisThread::Error.

Returns
Process-wide ThisThread category.

Variable Documentation

◆ EoF

const _EoF StormByte::System::EoF = {}
staticconstexpr

Sentinel used as process << System::EoF to close stdin.