README
¶
Luce
This collection of packages is the result of me (Adam Colton) reusing code. Over the course of several smaller projects I kept reusing the same code snippets. I'd find bugs and need to go update many projects. I started putting them all in this repo and it sort of took on a life of it's own
Current Status
Because this repo was initially just a place for me to dump shared code, it was a mess for a long time. Since early 2023 I've been working to clean it up, which has involved significantly re-writing history. As of late 2024, I've got most of the history in a decent state. Most of the code has good test coverage and about 75% has documentation.
I'm continuing to add coverage and documentation but I expect it will take a while longer to get fully caught up.
Buffers
In most functions that would need to allocate memory a buffer argument is supplied. It is always safe to use nil for a buffer. This pattern can avoid generating garbage often enough that it is useful and (by simply supplying nil) it is easy to ignore.
Wrapers
Several packages provide wrappers around builtin data structures or useful interfaces. The package util/upgrade provides a standard way to access the wrapped interface.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
luce
command
|
|
|
luce.server
command
luce.server runs an instance of luce/tools/server.
|
luce.server runs an instance of luce/tools/server. |
|
ds
|
|
|
bus/iobus
Package iobus converts an io.Reader or io.Writer to a chan []byte.
|
Package iobus converts an io.Reader or io.Writer to a chan []byte. |
|
huffman
Package huffman is used to build variable length codes for compression.
|
Package huffman is used to build variable length codes for compression. |
|
huffman/huffslice
Package huffslice compresses a slice using Huffman encoding.
|
Package huffslice compresses a slice using Huffman encoding. |
|
idx/byteid/testsuite
Package testsuite provides tests to validate that an implementation of byteid.Index is correct.
|
Package testsuite provides tests to validate that an implementation of byteid.Index is correct. |
|
idx/sliceidx
Package sliceidx provides SliceIdx as a building block for creating types that fulfill idx.Index.
|
Package sliceidx provides SliceIdx as a building block for creating types that fulfill idx.Index. |
|
lmap
Package lmap provides helpers for the built in map type.
|
Package lmap provides helpers for the built in map type. |
|
prefix
Package prefix holds a prefix tree for strings.
|
Package prefix holds a prefix tree for strings. |
|
toq
Package toq provides a queue for performing a timeout action after a constant period of time.
|
Package toq provides a queue for performing a timeout action after a constant period of time. |
|
example
|
|
|
commands/cmd/cli
command
|
|
|
commands/cmd/unixsocket
command
|
|
|
commands/cmd/webui
command
|
|
|
corpus
command
|
|
|
descent
command
|
|
|
luce.testservice
command
This demonstrates how to make a service for luce.server.
|
This demonstrates how to make a service for luce.server. |
|
midware
command
|
|
|
unixsocket
command
|
|
|
Package lerr provides helpers for error handling
|
Package lerr provides helpers for error handling |
|
midware
Package midware provides a way to convert a MidwareFunc to an http.HandlerFunc.
|
Package midware provides a way to convert a MidwareFunc to an http.HandlerFunc. |
|
math
|
|
|
poly
Package poly performs operations on polynomials.
|
Package poly performs operations on polynomials. |
|
rye
Package rye is a helper for writing serializing and deserializing logic.
|
Package rye is a helper for writing serializing and deserializing logic. |
|
wrap/testutil
Package testutil provides testing utilities for fulfilling serial interfaeces.
|
Package testutil provides testing utilities for fulfilling serial interfaeces. |
|
tools
|
|
|
util
|
|
|
lfile
Package lfile provides utilities around file interactions beyond those in the standard library.
|
Package lfile provides utilities around file interactions beyond those in the standard library. |
|
lfile/lfilemock
Package lfilemock provides some mock file objects.
|
Package lfilemock provides some mock file objects. |
|
liter
Package liter provides an iterator.
|
Package liter provides an iterator. |
|
luceio
Package luceio profides helpers that extend io in particular, helping build instances of Writer and WriterTo.
|
Package luceio profides helpers that extend io in particular, helping build instances of Writer and WriterTo. |
|
reflector
Package reflector provides a number of helpers for working with reflection.
|
Package reflector provides a number of helpers for working with reflection. |
|
timeout
Package timeout is primarily intended as a test utility.
|
Package timeout is primarily intended as a test utility. |
|
upgrade
Package upgrade solves an issue that results from the intersections of two common patterns in luce.
|
Package upgrade solves an issue that results from the intersections of two common patterns in luce. |