镜像自: https://github.com/DragonOS-Community/thingbuf.git

Eliza Weisman e8f7107ba0 docs: a bunch of internal implementation docs (#18) 3 years ago
.github b4e62fb730 chore(ci): check that benchmarks compile 3 years ago
bench d9474c626e test(bench) fix clippy lints in benchmarks 3 years ago
bin 974f51e02f chore(test): fix loom script not forwarding args 3 years ago
src e8f7107ba0 docs: a bunch of internal implementation docs (#18) 3 years ago
tests d590f6d937 test(mpsc): tests for draining after tx closes (#12) 3 years ago
.envrc 84b9ce7057 initial commit 3 years ago
.gitignore 84b9ce7057 initial commit 3 years ago
Cargo.toml e8f7107ba0 docs: a bunch of internal implementation docs (#18) 3 years ago
README.md 6ebfe7b8fd feat: add `Deref` and `DerefMut` impls to `Ref` types (#13) 3 years ago
default.nix 84b9ce7057 initial commit 3 years ago
shell.nix 84b9ce7057 initial commit 3 years ago

README.md

FAQs

  • Q: Why did you make this?

A: For tracing, I wanted to be able to send formatted log lines to a dedicated worker thread that writes them to a file. Right now, we do this using crossbeam-channel. However, this has the sad disadvantage that we have to allocate Strings, send them through the channel to the writer, and immediately drop them. It would be nice to do this while reusing those allocations. Thus...StringBuf.

  • Q: Is it lock-free?

A: Extremely.

  • Q: Is it wait-free?

A: As long as you don't use the APIs that wait :)

  • Q: Why is there only a bounded variant?

A: Because unbounded queues are of the Devil.

  • Q: Isn't this just a giant memory leak?

A: If you use it wrong, yes.

  • Q: Why is it called that?

A: Originally, I imagined it as a kind of ring buffer, so (as a pun on "ringbuf"), I called it "stringbuf". Then, I realized you could do this with more than just strings. In fact, it can be generalized to arbitrary...things. So, "thingbuf".