StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
typedefs.hxx File Reference
#include <StormByte/type_traits/safe.hxx>
#include <StormByte/buffer/visibility.h>
#include <StormByte/byte_size.hxx>
#include <StormByte/platform.h>
#include <StormByte/type_traits.hxx>
#include <string_view>
Include dependency graph for typedefs.hxx:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  StormByte::Buffer::IO::Result
 Per-call status plus how many bytes this call transferred. More...

Namespaces

namespace  StormByte
 Root namespace of the StormByte C++ suite.
namespace  StormByte::Buffer
 Buffer module of the StormByte suite.
namespace  StormByte::Buffer::IO
 Buffered binary sources and sinks.
namespace  StormByte::Buffer::IO::Drainer
 Status and operations of a Bridge pump thread.

Enumerations

enum class  StormByte::Buffer::IO::Status {
  StormByte::Buffer::IO::Ok , StormByte::Buffer::IO::End , StormByte::Buffer::IO::Error , StormByte::Buffer::IO::Failed ,
  StormByte::Buffer::IO::TryAgain
}
 Outcome of a single I/O call. More...
enum class  StormByte::Buffer::IO::State {
  StormByte::Buffer::IO::Idle , StormByte::Buffer::IO::Missing , StormByte::Buffer::IO::Directory , StormByte::Buffer::IO::Permission ,
  StormByte::Buffer::IO::NotWritable , StormByte::Buffer::IO::Fault , StormByte::Buffer::IO::Unavailable
}
 Session state of a coordinated reader or writer. More...
enum class  StormByte::Buffer::IO::Location { StormByte::Buffer::IO::Local , StormByte::Buffer::IO::Remote }
 Where the bytes of a file-like source or sink live. More...
enum class  StormByte::Buffer::IO::Drainer::Status { StormByte::Buffer::IO::Drainer::Started , StormByte::Buffer::IO::Drainer::Paused , StormByte::Buffer::IO::Drainer::Stopped }
 Whether the Bridge worker is pumping. More...
enum class  StormByte::Buffer::IO::Drainer::Operation { StormByte::Buffer::IO::Drainer::Toggle , StormByte::Buffer::IO::Drainer::Flush }
 Verbs for Bridge::Drainer. More...

Functions

STORMBYTE_FORCE_INLINE constexpr std::string_view StormByte::Buffer::IO::ToString (Status status) noexcept
 Enumerator name of status.
STORMBYTE_FORCE_INLINE constexpr std::string_view StormByte::Buffer::IO::ToString (State state) noexcept
 Enumerator name of state.
STORMBYTE_FORCE_INLINE constexpr std::string_view StormByte::Buffer::IO::ToString (Location location) noexcept
 Enumerator name of location.
STORMBYTE_FORCE_INLINE constexpr std::string_view StormByte::Buffer::IO::Drainer::ToString (Status status) noexcept
 Enumerator name of status.
STORMBYTE_FORCE_INLINE constexpr std::string_view StormByte::Buffer::IO::Drainer::ToString (Operation operation) noexcept
 Enumerator name of operation.
 STORMBYTE_DECLARE_MAYBE_SAFE (StormByte::Buffer::IO::Result)

Function Documentation

◆ STORMBYTE_DECLARE_MAYBE_SAFE()

STORMBYTE_DECLARE_MAYBE_SAFE ( StormByte::Buffer::IO::Result )