Skip to content

Commit

Permalink
docs(README): fix doc links to blocking module (#68)
Browse files Browse the repository at this point in the history
Fixes a couple of links in the `README` that are broken
since the `sync` module was renamed to `blocking`.
  • Loading branch information
ericseppanen authored Oct 4, 2022
1 parent 0cf1ea2 commit 0d322c4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

`thingbuf` is a lock-free array-based concurrent ring buffer that allows access
to slots in the buffer by reference. It's also [asynchronous][`thingbuf::mpsc`]
and [blocking][`thingbuf::mpsc::sync`] bounded MPSC channels implemented using
and [blocking][`thingbuf::mpsc::blocking`] bounded MPSC channels implemented using
the ring buffer.

### When Should I Use It?
Expand All @@ -38,7 +38,7 @@ the ring buffer.
[`thingbuf::mpsc`] is a competitive choice for a general-purpose
MPSC channel in most use cases.

Both [asynchronous][`thingbuf::mpsc`] and [blocking][`thingbuf::mpsc::sync`]
Both [asynchronous][`thingbuf::mpsc`] and [blocking][`thingbuf::mpsc::blocking`]
MPSC channels are available, so `thingbuf` can be used in place
of asynchronous channels like [`futures::channel::mpsc`] *and* blocking
channels like [`std::sync::mpsc::sync_channel`].
Expand Down Expand Up @@ -198,11 +198,11 @@ feature flag requries Rust 1.60+.
So, "thingbuf".

[`thingbuf::mpsc`]: https://docs.rs/thingbuf/0.1/thingbuf/mpsc/index.html
[`thingbuf::mpsc::sync`]: https://docs.rs/thingbuf/0.1/thingbuf/mpsc/sync/index.html
[`thingbuf::mpsc::blocking`]: https://docs.rs/thingbuf/0.1/thingbuf/mpsc/blocking/index.html
[static-queue]: https://docs.rs/thingbuf/0.1/thingbuf/struct.StaticThingBuf.html
[static-mpsc]: https://docs.rs/thingbuf/0.1./thingbuf/mpsc/struct.StaticChannel.html
[`futures::channel::mpsc`]: https://docs.rs/futures/latest/futures/channel/mpsc/index.html
[`std::sync::mpsc::sync_channel`]: https://doc.rust-lang.org/stable/std/sync/mpsc/fn.sync_channel.html
[`tokio::sync::mpsc`]: https://docs.rs/tokio/latest/tokio/sync/mpsc/index.html
[`tracing`]: https://crates.io/crates/tracing
[`crossbeam-channel`]: https://crates.io/crates/crossbeam-channel
[`crossbeam-channel`]: https://crates.io/crates/crossbeam-channel

0 comments on commit 0d322c4

Please sign in to comment.