README
¶
Primordium
A small Go library containing a handful of utility components shared in all our projects.
Purpose
Primordium provides generic helpers for all Mycophonic audio Go project.
- a filesystem layer that provides locking, atomic writes, buffered readers and writers, OS specific limitations handling, ref-counting
- networking secure defaults for ssh and http
- standardized errors
- output formatting helpers
- digest computation
- logger configuration helpers and other "app" oriented helpers
- SIMD assembly for audio processing
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app provides application lifecycle helpers (initialization for filesystem, network, logger) and shutdown.
|
Package app provides application lifecycle helpers (initialization for filesystem, network, logger) and shutdown. |
|
logger
Package logger configures zerolog with sensible defaults as a backend for stdlib slog.
|
Package logger configures zerolog with sensible defaults as a backend for stdlib slog. |
|
shutdown
Package shutdown manages graceful process exit with registered cleanup handlers.
|
Package shutdown manages graceful process exit with registered cleanup handlers. |
|
db
|
|
|
sqlite
Package sqlite provides shared SQLite database wrapper along with the default pure go driver.
|
Package sqlite provides shared SQLite database wrapper along with the default pure go driver. |
|
Package digest provides core types for digest handling and content-addressable storage.
|
Package digest provides core types for digest handling and content-addressable storage. |
|
Package fault provides a set of errors consistently used across quark codebase.
|
Package fault provides a set of errors consistently used across quark codebase. |
|
Package filesystem provides low level primitives to ease FS manipulation.
|
Package filesystem provides low level primitives to ease FS manipulation. |
|
Package format provides output formatters for hypha.
|
Package format provides output formatters for hypha. |
|
Package network currently provides sane defaults http and ssh transport config to be used across all network operations.
|
Package network currently provides sane defaults http and ssh transport config to be used across all network operations. |
|
Package reporter wrapper abstracting Sentry.
|
Package reporter wrapper abstracting Sentry. |
|
Package simd provides SIMD-accelerated operations for float32 slices.
|
Package simd provides SIMD-accelerated operations for float32 slices. |
|
Package store provides cache and volatile storage facilities.
|
Package store provides cache and volatile storage facilities. |
|
wrap
|
|
|
primos
Package primos provides the same filesystem features as golang os package, with a key difference on windows (FILE_SHARE_DELETE), which is the default for rust.
|
Package primos provides the same filesystem features as golang os package, with a key difference on windows (FILE_SHARE_DELETE), which is the default for rust. |
Click to show internal directories.
Click to hide internal directories.