summaryrefslogtreecommitdiffhomepage
path: root/doc/requirements/UnbufferedStream.md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2026-03-07 11:33:23 +0100
committerGitHub <noreply@github.com>2026-03-07 11:33:23 +0100
commitb7d4f9943ca6d2561a31fc212b8e074e4984b850 (patch)
treeeac88db0b56afbe6d62f4692855e38ca5e2b652c /doc/requirements/UnbufferedStream.md
parent1fc1b9c7e89d4691c82cc434d43bbfdc221cb5b1 (diff)
parent3edb3cb672aa5008225a40020bbc707730897cab (diff)
Merge pull request #127 from ne-foss-org/buffered-stream-requirements
[FEAT] Buffered and Unbuffered stream types.
Diffstat (limited to 'doc/requirements/UnbufferedStream.md')
-rw-r--r--doc/requirements/UnbufferedStream.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/requirements/UnbufferedStream.md b/doc/requirements/UnbufferedStream.md
new file mode 100644
index 00000000..d3bfd8eb
--- /dev/null
+++ b/doc/requirements/UnbufferedStream.md
@@ -0,0 +1,19 @@
+# UnbufferedStream
+
+## Abstract:
+
+One type that has to satisfy an unbuffered Stream operator and type.
+
+## Rationale:
+
+- Fast and direct-flush operations.
+- High-Throughput systems.
+
+## Example:
+
+```cpp
+UBStream<UBOperator, UBType>;
+```
+
+UBOperator must flush at all times!
+