https://github.com/maxim2266/stout
Package stout (STream OUTput): writing byte streams in a type-safe and extensible way.
https://github.com/maxim2266/stout
byte-stream composition go golang golang-package type-safety
Last synced: about 1 year ago
JSON representation
Package stout (STream OUTput): writing byte streams in a type-safe and extensible way.
- Host: GitHub
- URL: https://github.com/maxim2266/stout
- Owner: maxim2266
- License: bsd-3-clause
- Archived: true
- Created: 2019-11-17T21:05:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-06T11:25:20.000Z (over 1 year ago)
- Last Synced: 2025-04-14T07:06:42.013Z (about 1 year ago)
- Topics: byte-stream, composition, go, golang, golang-package, type-safety
- Language: Go
- Size: 41 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stout
[](https://godoc.org/github.com/maxim2266/stout)
[](https://goreportcard.com/report/github.com/maxim2266/stout)
[](https://opensource.org/licenses/BSD-3-Clause)
Package `stout` (STream OUTput): writing byte streams in a type-safe and extensible way.
### Motivation
In Go, writing files or other byte streams (pipes, sockets, etc.) is where all that error-checking
boilerplate code pops up, obscuring program logic and making the source code harder to read.
This project is an attempt to improve the situation. The main goals of the project are:
* Reduce the amount of error-checking boilerplate code;
* Make writing multi-part byte streams look more like a declarative composition, as much as possible with Go syntax;
* Develop an API that can be easily extended for any custom type or operation;
* Provide some generally useful functions for real-life applications.
The core ideas behind the implementation of the package are described in [this](https://maxim2266.github.io/stout/) blog post.
### Examples
##### "Hello, user" application:
```Go
func main() {
_, err := stout.WriterBufferedStream(os.Stdout).Write(
stout.String("Hello, "),
stout.String(os.Getenv("USER")),
stout.String("!\n"),
)
if err != nil {
println("ERROR:", err.Error())
os.Exit(1)
}
}
```
##### Simplified implementation of `cat` command:
```Go
func main() {
files := make([]stout.Chunk, 0, len(os.Args)-1)
for _, arg := range os.Args[1:] {
files = append(files, stout.File(arg))
}
_, err := stout.WriterBufferedStream(os.Stdout).Write(files...)
if err != nil {
println("ERROR:", err.Error())
os.Exit(1)
}
}
```
##### Report generator
A complete application that generates a simple HTML page from `ps` command output:
```go
func main() {
// run "ps" command
lines, err := ps()
if err != nil {
die(err.Error())
}
// compose HTML
// note: in a real-life application we would be writing to a socket instead of stdout
_, err = stout.WriterBufferedStream(os.Stdout).Write(
stout.String(hdr),
stout.Repeat(rowsFrom(lines)),
stout.String("
pidcpumemcmd`
```
### Status
Tested on Linux Mint 20.2 with Go version 1.16.6.