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

Eliza Weisman 7a2beae342 chore(test): minor loom fixups 3 years ago
.github 9e413bb759 chore(ci): no tests on PRs that don't touch code 3 years ago
bench 5e26864245 chore: no benchmark-only dev-deps in tests (#11) 3 years ago
bin 7a2beae342 chore(test): minor loom fixups 3 years ago
src 7a2beae342 chore(test): minor loom fixups 3 years ago
tests 76df064cbf feat(mpsc): add waiting `send`/`send_ref` (#7) 3 years ago
.envrc 84b9ce7057 initial commit 3 years ago
.gitignore 84b9ce7057 initial commit 3 years ago
Cargo.toml 5e26864245 chore: no benchmark-only dev-deps in tests (#11) 3 years ago
README.md b990dc80cc docs: fix markdown in FAQ 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: 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".

  • Q: Why don't the Ref types implement Deref and DerefMut?

A: Blame loom for this.

  • Q: Why do the channels only have try_send? Where's send?

A: I haven't written send yet. :)