From 0d322c4f632bee4959beb60ea0d8f71802f7a2ad Mon Sep 17 00:00:00 2001 From: Eric Seppanen Date: Tue, 4 Oct 2022 16:28:41 -0700 Subject: [PATCH] docs(README): fix doc links to blocking module (#68) Fixes a couple of links in the `README` that are broken since the `sync` module was renamed to `blocking`. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a71aad5..3168db8 100644 --- a/README.md +++ b/README.md @@ -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? @@ -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`]. @@ -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 \ No newline at end of file +[`crossbeam-channel`]: https://crates.io/crates/crossbeam-channel