Skip to content

Commit 11067a9

Browse files
committed
Fix typo
1 parent efb9039 commit 11067a9

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Implemented with lockless in mind, low level is based on crossbeam-channel.
2121

2222
Crossfire v1.0 has been released and used in production since 2022.12. Heavily tested on X86_64 and ARM.
2323

24-
v2.0 has refactored the codebase and API at 2025.6. By removing generic types of ChanelShare object in sender and receiver,
24+
V2.0 has refactored the codebase and API at 2025.6. By removing generic types of ChanelShared object in sender and receiver,
2525
it's easier to remember and code.
2626

27-
v2.0.x branch will remain in maintenance mode. Further optimization might be in v2.x_beta
27+
V2.0.x branch will remain in maintenance mode. Further optimization might be in v2.x_beta
2828
version until long run tests prove to be stable.
2929

3030
## Performance
@@ -113,7 +113,7 @@ While using MAsyncTx or MAsyncRx, there's memory overhead to pass along small si
113113
for pending async producer or consumer. Because we aim to be lockless,
114114
when the sending/receiving futures are cancelled (like tokio::time::timeout()),
115115
might trigger immediate cleanup if non-conflict conditions are met.
116-
Otherwise will rely on lazy cleanup. (waker will be consumed by actural message send and recv).
116+
Otherwise will rely on lazy cleanup. (waker will be consumed by actual message send and recv).
117117

118118
Never the less, for close notification without sending anything,
119119
I suggest that use `tokio::sync::oneshot` instead.

src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
//!
1111
//! Crossfire v1.0 has been released and used in production since 2022.12. Heavily tested on X86_64 and ARM.
1212
//!
13-
//! v2.0 has refactored the codebase and API at 2025.6. By removing generic types of ChanelShare object in sender and receiver,
13+
//! V2.0 has refactored the codebase and API at 2025.6. By removing generic types of ChannelShared object in sender and receiver,
1414
//! it's easier to remember and code.
1515
//!
16-
//! v2.0.x branch will remain in maintenance mode. Future optimization might be in v2.x_beta
16+
//! V2.0.x branch will remain in maintenance mode. Future optimization might be in v2.x_beta
1717
//! version until long run tests prove to be stable.
1818
//!
1919
//! ## Performance
@@ -95,7 +95,7 @@
9595
//! for pending async producer or consumer. Because we aim to be lockless,
9696
//! when the sending/receiving futures are cancelled (like tokio::time::timeout()),
9797
//! might trigger immediate cleanup if non-conflict conditions are met.
98-
//! Otherwise will rely on lazy cleanup. (waker will be consumed by actural message send and recv).
98+
//! Otherwise will rely on lazy cleanup. (waker will be consumed by actual message send and recv).
9999
//!
100100
//! Never the less, for close notification without sending anything,
101101
//! I suggest that use `tokio::sync::oneshot` instead.

src/mpmc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::m_tx::*;
55

66
/// Initiate a unbounded channel.
77
///
8-
/// Altough sender type is MTx, will never block.
8+
/// Although sender type is MTx, will never block.
99
pub fn unbounded_async<T: Unpin>() -> (MTx<T>, MAsyncRx<T>) {
1010
let (tx, rx) = crossbeam::channel::unbounded();
1111

src/mpsc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::rx::*;
55

66
/// Initiate a unbounded channel.
77
///
8-
/// Altough sender type is MTx, will never block.
8+
/// Although sender type is MTx, will never block.
99
pub fn unbounded_async<T: Unpin>() -> (MTx<T>, AsyncRx<T>) {
1010
let (tx, rx) = crossbeam::channel::unbounded();
1111
let send_wakers = SendWakersBlocking::new();

src/rx.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ impl<T> AsyncRx<T> {
257257
}
258258
}
259259

260-
/// A fixed-sized future object contructed by [AsyncRx::make_recv_future()]
260+
/// A fixed-sized future object constructed by [AsyncRx::make_recv_future()]
261261
pub struct ReceiveFuture<'a, T> {
262262
rx: &'a AsyncRx<T>,
263263
waker: Option<LockedWaker>,
@@ -268,7 +268,7 @@ impl<T> Drop for ReceiveFuture<'_, T> {
268268
if let Some(waker) = self.waker.take() {
269269
// Cancelling the future, poll is not ready
270270
if waker.abandon() {
271-
// We are waked, but giving up to recv, should notify another receiver for safty
271+
// We are waked, but giving up to recv, should notify another receiver for safety
272272
self.rx.shared.on_send();
273273
} else {
274274
self.rx.shared.clear_recv_wakers(waker.get_seq());

src/stream.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use futures::stream;
44
use std::pin::Pin;
55
use std::task::*;
66

7-
/// Contructed by [AsyncRx::into_stream()](crate::AsyncRx::into_stream())
7+
/// Constructed by [AsyncRx::into_stream()](crate::AsyncRx::into_stream())
88
///
99
/// Implemented futures::stream::Stream;
1010
pub struct AsyncStream<T>

src/tx.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ impl<T> AsyncTx<T> {
244244
}
245245
}
246246

247-
/// A fixed-sized future object construted by [AsyncTx::make_send_future()]
247+
/// A fixed-sized future object constructed by [AsyncTx::make_send_future()]
248248
pub struct SendFuture<'a, T: Unpin> {
249249
tx: &'a AsyncTx<T>,
250250
item: Option<T>,
@@ -256,7 +256,7 @@ impl<T: Unpin> Drop for SendFuture<'_, T> {
256256
if let Some(waker) = self.waker.take() {
257257
// Cancelling the future, poll is not ready
258258
if waker.abandon() {
259-
// We are waked, but give up sending, should notify another sender for safty
259+
// We are waked, but give up sending, should notify another sender for safety
260260
self.tx.shared.on_recv();
261261
} else {
262262
self.tx.shared.clear_send_wakers(waker.get_seq());

0 commit comments

Comments
 (0)