Skip to content

README: make the ringbuffer names link to the docs #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdonszelmann merged 2 commits into from
Jun 8, 2023
Merged

README: make the ringbuffer names link to the docs #107

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38c6c72
README: make the ringbuffer names link to the docs
tertsdiepraam Jun 8, 2023
9777399
README: link to the RingBuffer trait
tertsdiepraam Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ The ringbuffer crate provides safe fixed size circular buffers (ringbuffers) in

Implementations for three kinds of ringbuffers, with a mostly similar API are provided:

| type | description |
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `AllocRingBuffer` | Ringbuffer allocated on the heap at runtime. This ringbuffer is still fixed size. This requires alloc and the alloc feature. |
| `GrowableAllocRingBuffer` | Ringbuffer allocated on the heap at runtime. This ringbuffer can grow in size, and is implemented as an `alloc::VecDeque` internally. This requires alloc and the alloc feature. |
| `ConstGenericRingBuffer` | Ringbuffer which uses const generics to allocate on the stack. |

All of these ringbuffers also implement the RingBuffer trait for their shared API surface.

| type | description |
|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`AllocRingBuffer`][1] | Ringbuffer allocated on the heap at runtime. This ringbuffer is still fixed size. This requires alloc and the alloc feature. |
| [`GrowableAllocRingBuffer`][2] | Ringbuffer allocated on the heap at runtime. This ringbuffer can grow in size, and is implemented as an `alloc::VecDeque` internally. This requires alloc and the alloc feature. |
| [`ConstGenericRingBuffer`][3] | Ringbuffer which uses const generics to allocate on the stack. |

All of these ringbuffers also implement the [RingBuffer][4] trait for their shared API surface.

[1]: https://docs.rs/ringbuffer/latest/ringbuffer/struct.AllocRingBuffer.html
[2]: https://docs.rs/ringbuffer/latest/ringbuffer/struct.GrowableAllocRingBuffer.html
[3]: https://docs.rs/ringbuffer/latest/ringbuffer/struct.ConstGenericRingBuffer.html
[4]: https://docs.rs/ringbuffer/latest/ringbuffer/trait.RingBuffer.html

MSRV: Rust 1.59

Expand Down