DebugStream Struct

Streaming iterator over debug-mode pipeline outputs. More...

Declaration

struct simaai::neat::debug::DebugStream { ... }

Included Headers

#include <DebugTypes.h>

Public Operators Index

	operator bool () const
	True iff the stream is bound and usable. More...

Public Member Attributes Index

std::function< std::optional< DebugOutput >(int)>	next
	Pull next output; arg is timeout_ms. More...
std::function< void()>	close
	Tear down the underlying stream. More...
OutputSpec	expected
	Expected output spec. More...
OutputSpec	observed
	Spec observed at runtime. More...
std::string	caps_string
	Payload caps string. More...
bool	tensorizable = false
	True iff outputs are tensorizable. More...
bool	unknown = false
	True iff payload type was unrecognised. More...
std::shared_ptr< void >	state
	Keeps the underlying pipeline/stream alive. More...

Description

Streaming iterator over debug-mode pipeline outputs.

next(timeout_ms) returns the next captured output (or std::nullopt on timeout / end-of-stream). close() tears the underlying stream down. The state shared pointer keeps any backing pipeline alive for as long as the stream is held. The boolean conversion reports whether the stream is usable (i.e., whether next is bound).

Definition at line 71 of file DebugTypes.h.

Public Operators

operator bool()

simaai::neat::debug::DebugStream::operator bool ()

inline explicit

True iff the stream is bound and usable.

Definition at line 82 of file DebugTypes.h.

82 explicit operator bool() const {

83 return static_cast<bool>(next);

84 }

Public Member Attributes

caps_string

std::string simaai::neat::debug::DebugStream::caps_string

Payload caps string.

Definition at line 76 of file DebugTypes.h.

76 std::string caps_string;

close

std::function<void()> simaai::neat::debug::DebugStream::close

Tear down the underlying stream.

Definition at line 73 of file DebugTypes.h.

73 std::function<void()> close;

expected

OutputSpec simaai::neat::debug::DebugStream::expected

Expected output spec.

Definition at line 74 of file DebugTypes.h.

74 OutputSpec expected;

next

std::function<std::optional<DebugOutput>(int)> simaai::neat::debug::DebugStream::next

Pull next output; arg is timeout_ms.

Definition at line 72 of file DebugTypes.h.

72 std::function<std::optional<DebugOutput>(int)> next;

observed

OutputSpec simaai::neat::debug::DebugStream::observed

Spec observed at runtime.

Definition at line 75 of file DebugTypes.h.

75 OutputSpec observed;

state

std::shared_ptr<void> simaai::neat::debug::DebugStream::state

Keeps the underlying pipeline/stream alive.

Definition at line 79 of file DebugTypes.h.

79 std::shared_ptr<void> state;

tensorizable

bool simaai::neat::debug::DebugStream::tensorizable = false

True iff outputs are tensorizable.

Definition at line 77 of file DebugTypes.h.

77 bool tensorizable = false;

unknown

bool simaai::neat::debug::DebugStream::unknown = false

True iff payload type was unrecognised.

Definition at line 78 of file DebugTypes.h.

78 bool unknown = false;

---

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

• DebugTypes.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.