search

NULLx76 / ringbuffer

A fixed-size circular buffer written in Rust.
https://crates.io/crates/ringbuffer
MIT License
95 stars 20 forks source link

README: add table with ringbuffer properties #112

Closed tertsdiepraam closed 1 year ago

tertsdiepraam commented 1 year ago

I thought an overview of features of the ringbuffers was missing, even though the descriptions technically cover most of it. The README currently also lacks some info about where powers of two are important, so I added a bit of that here too.

I'm not quite sure what should be in here exactly and how it should look. So consider this PR a request for feedback and I'll open it as a draft.

NULLx76 commented 1 year ago

Technically all the ringbuffers are no_std, just some need alloc which is actually reasonably available on embedded platforms, so might be nice to be specific about that.

NULLx76 commented 1 year ago

Additionally some kind of performance comparison might be neat as well, @jonay2000 you ran some benchmarks right?

jdonszelmann commented 1 year ago

yup, working on it :)

tertsdiepraam commented 1 year ago

Technically all the ringbuffers are no_std, just some need alloc which is actually reasonably available on embedded platforms, so might be nice to be specific about that.

Makes sense! I'll try to fix it

jdonszelmann commented 1 year ago

See #113, based on this branch

tertsdiepraam commented 1 year ago

@jonay2000 shall I just let you fix the table and close this then?