mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-07 00:00:09 +02:00
docs: correct spelling typos in comments and doc strings (#8263)
Fix several spelling errors found in comments and documentation: - mulithreading -> multithreading (tcp_shutdown.rs) - succeded -> succeeded (signal/windows/sys.rs) - implementor/implementors -> implementer/implementers (multiple files) Co-authored-by: maxtaran2010 <[email protected]> Co-authored-by: Claude Sonnet 4.6 <[email protected]> Co-authored-by: Alice Ryhl <[email protected]>
This commit is contained in:
co-authored by
maxtaran2010
Claude Sonnet 4.6
Alice Ryhl
parent
cd3bcca32b
commit
bfd4ddf597
@@ -47,7 +47,7 @@ pub trait Decoder {
|
||||
/// implementation of `decode_eof` to yield an `io::Error` when the decoder
|
||||
/// fails to consume all available data.
|
||||
///
|
||||
/// Note that implementors of this trait can simply indicate `type Error =
|
||||
/// Note that implementers of this trait can simply indicate `type Error =
|
||||
/// io::Error` to use I/O errors as this type.
|
||||
///
|
||||
/// [`FramedRead`]: crate::codec::FramedRead
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
//! The following example demonstrates how to use a codec such as [`LinesCodec`] to
|
||||
//! write framed data. [`FramedWrite`] can be used to achieve this. Data sent to
|
||||
//! [`FramedWrite`] are first framed according to a specific codec, and then sent to
|
||||
//! an implementor of [`AsyncWrite`].
|
||||
//! an implementer of [`AsyncWrite`].
|
||||
//!
|
||||
//! ```
|
||||
//! use futures::sink::SinkExt;
|
||||
@@ -43,7 +43,7 @@
|
||||
//! # Example decoding using `LinesCodec`
|
||||
//! The following example demonstrates how to use a codec such as [`LinesCodec`] to
|
||||
//! read a stream of framed data. [`FramedRead`] can be used to achieve this. [`FramedRead`]
|
||||
//! will keep reading from an [`AsyncRead`] implementor until a whole frame, according to a codec,
|
||||
//! will keep reading from an [`AsyncRead`] implementer until a whole frame, according to a codec,
|
||||
//! can be parsed.
|
||||
//!
|
||||
//!```
|
||||
|
||||
@@ -15,8 +15,8 @@ use std::task::{ready, Context, Poll};
|
||||
|
||||
/// Like [`mio::event::Source`], but for POSIX AIO only.
|
||||
///
|
||||
/// Tokio's consumer must pass an implementor of this trait to create a
|
||||
/// [`Aio`] object. Implementors must implement at least one of [`AioSource::register`] and
|
||||
/// Tokio's consumer must pass an implementer of this trait to create a
|
||||
/// [`Aio`] object. Implementers must implement at least one of [`AioSource::register`] and
|
||||
/// [`AioSource::register_borrowed`].
|
||||
pub trait AioSource {
|
||||
/// Registers this AIO event source with Tokio's reactor.
|
||||
@@ -27,7 +27,7 @@ pub trait AioSource {
|
||||
/// source may end up notifying the wrong file.
|
||||
#[deprecated(since = "1.52.0", note = "use register_borrowed instead")]
|
||||
fn register(&mut self, _kq: RawFd, _token: usize) {
|
||||
// This default implementation exists so new AioSource implementors that implement the
|
||||
// This default implementation exists so new AioSource implementers that implement the
|
||||
// register_borrowed method can compile without the need to implement register.
|
||||
unimplemented!("Use AioSource::register_borrowed instead")
|
||||
}
|
||||
@@ -35,7 +35,7 @@ pub trait AioSource {
|
||||
/// Registers this AIO event source with Tokio's reactor.
|
||||
fn register_borrowed(&mut self, kq: BorrowedFd<'_>, token: usize) {
|
||||
// This default implementation serves to provide backwards compatibility with AioSource
|
||||
// implementors written before 1.52.0 that only implemented the unsafe `register` method.
|
||||
// implementers written before 1.52.0 that only implemented the unsafe `register` method.
|
||||
#[allow(deprecated)]
|
||||
self.register(kq.as_raw_fd(), token)
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ use std::mem::MaybeUninit;
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// The implementor must guarantee that the vector returned by the
|
||||
/// The implementer must guarantee that the vector returned by the
|
||||
/// `as_mut` and `as_mut` methods do not change from one call to
|
||||
/// another.
|
||||
pub(crate) unsafe trait VecU8: AsRef<Vec<u8>> + AsMut<Vec<u8>> {}
|
||||
|
||||
@@ -69,7 +69,7 @@ impl TcpListener {
|
||||
/// to this listener. The port allocated can be queried via the `local_addr`
|
||||
/// method.
|
||||
///
|
||||
/// The address type can be any implementor of the [`ToSocketAddrs`] trait.
|
||||
/// The address type can be any implementer of the [`ToSocketAddrs`] trait.
|
||||
/// If `addr` yields multiple addresses, bind will be attempted with each of
|
||||
/// the addresses until one succeeds and returns the listener. If none of
|
||||
/// the addresses succeed in creating a listener, the error returned from
|
||||
|
||||
@@ -1149,7 +1149,7 @@ impl UdpSocket {
|
||||
/// Sends data on the socket to the given address. On success, returns the
|
||||
/// number of bytes written.
|
||||
///
|
||||
/// Address type can be any implementor of [`ToSocketAddrs`] trait. See its
|
||||
/// Address type can be any implementer of [`ToSocketAddrs`] trait. See its
|
||||
/// documentation for concrete examples.
|
||||
///
|
||||
/// It is possible for `addr` to yield multiple addresses, but `send_to`
|
||||
|
||||
@@ -111,7 +111,7 @@ unsafe extern "system" fn handler(ty: u32) -> BOOL {
|
||||
// `SetConsoleCtrlHandler` and `REGISTRY` being initialized.
|
||||
let Ok(registry) = REGISTRY.wait().as_ref() else {
|
||||
// Technically unreachable since `handler` is only called if
|
||||
// `SetConsoleCtrlHandler` succeded.
|
||||
// `SetConsoleCtrlHandler` succeeded.
|
||||
return 0;
|
||||
};
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
#![warn(rust_2018_idioms)]
|
||||
#![cfg(all(feature = "full", not(target_os = "wasi")))] // Wasi doesn't support mulithreading
|
||||
#![cfg(all(feature = "full", not(target_os = "wasi")))] // Wasi doesn't support multithreading
|
||||
|
||||
use tokio::io::{self, AsyncReadExt, AsyncWriteExt};
|
||||
use tokio::net::{TcpListener, TcpStream};
|
||||
|
||||
Reference in New Issue
Block a user