pulp::runtime::StreamResult Struct Reference

Result of a Stream read/write. More...

#include <stream.hpp>

Public Member Functions
constexpr bool	ok () const
constexpr bool	would_block () const
constexpr bool	closed () const

Static Public Member Functions
static constexpr StreamResult	make (std::size_t n)
static constexpr StreamResult	fail (StreamError e)

Public Attributes
std::size_t	bytes = 0
StreamError	error = StreamError::Ok

Detailed Description

Result of a Stream read/write.

Consumers should check ok() first. On ok():

• bytes == 0 means "end of stream" for read, "no room" for write (backends that do not distinguish will report Closed / WouldBlock).
• bytes > 0 means that many bytes were transferred.

Member Function Documentation

closed()

bool pulp::runtime::StreamResult::closed ( ) const

inlineconstexpr

fail()

constexpr StreamResult pulp::runtime::StreamResult::fail ( StreamError e )

inlinestaticconstexpr

make()

constexpr StreamResult pulp::runtime::StreamResult::make ( std::size_t n )

inlinestaticconstexpr

ok()

bool pulp::runtime::StreamResult::ok ( ) const

inlineconstexpr

would_block()

bool pulp::runtime::StreamResult::would_block ( ) const

inlineconstexpr

Member Data Documentation

bytes

std::size_t pulp::runtime::StreamResult::bytes = 0

error

StreamError pulp::runtime::StreamResult::error = StreamError::Ok

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/core/runtime/include/pulp/runtime/stream.hpp