Структура OwnedReadHalf

Пытается соединить две половины TcpStream и восстановить исходный сокет. Успешно только в том случае, если обе половины были получены в результате одного и того же вызова into_split.

Пытается получить данные из сокета, не удаляя их из очереди, и регистрирует текущую задачу для пробуждения, если данные ещё недоступны.

Обратите внимание: при нескольких вызовах poll_peek или poll_read для пробуждения планируется только Waker из Context, переданного в последнем вызове.

Дополнительные сведения см. в документации уровня TcpStream::poll_peek.

Примеры

use tokio::io::{self, ReadBuf};
use tokio::net::TcpStream;

use std::future::poll_fn;

#[tokio::main]
async fn main() -> io::Result<()> {
    let stream = TcpStream::connect("127.0.0.1:8000").await?;
    let (mut read_half, _) = stream.into_split();
    let mut buf = [0; 10];
    let mut buf = ReadBuf::new(&mut buf);

    poll_fn(|cx| {
        read_half.poll_peek(cx, &mut buf)
    }).await?;

    Ok(())
}

Получает данные из сокета от удалённого адреса, с которым он соединён, не удаляя их из очереди. В случае успеха возвращает количество просмотренных байтов.

Дополнительные сведения см. в документации уровня TcpStream::peek.

Примеры

use tokio::net::TcpStream;
use tokio::io::AsyncReadExt;
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    // Connect to a peer
    let stream = TcpStream::connect("127.0.0.1:8080").await?;
    let (mut read_half, _) = stream.into_split();

    let mut b1 = [0; 10];
    let mut b2 = [0; 10];

    // Peek at the data
    let n = read_half.peek(&mut b1).await?;

    // Read the data
    assert_eq!(n, read_half.read(&mut b2[..n]).await?);
    assert_eq!(&b1[..n], &b2[..n]);

    Ok(())
}

Метод read определён в трейте AsyncReadExt.

Ожидает наступления любого из запрошенных состояний готовности.

Эта функция обычно используется вместе с try_read(). Вместо readable() её можно использовать для проверки возвращённого набора состояний готовности на наличие событий Ready::READABLE и Ready::READ_CLOSED.

Функция может завершиться, даже если сокет не готов. Это ложноположительный результат, и попытка выполнить операцию вернёт io::ErrorKind::WouldBlock. Функция также может вернуть пустой набор Ready, поэтому всегда следует проверять возвращённое значение и, возможно, ожидать снова, если запрошенные состояния не установлены.

Эта функция эквивалентна TcpStream::ready.

Безопасность при отмене

Этот метод безопасен при отмене. После наступления события готовности метод будет немедленно возвращать результат, пока это событие не будет обработано попыткой чтения или записи, завершившейся с ошибкой WouldBlock или Poll::Pending.

Ожидает, пока сокет не станет доступен для чтения.

Эта функция эквивалентна ready(Interest::READABLE) и обычно используется вместе с try_read().

Эта функция также эквивалентна TcpStream::ready.

Безопасность при отмене

Этот метод безопасен при отмене. После наступления события готовности метод будет немедленно возвращать результат, пока это событие не будет обработано попыткой чтения, завершившейся с ошибкой WouldBlock или Poll::Pending.

Пытается прочитать данные из потока в предоставленный буфер и возвращает количество прочитанных байтов.

Получает все ожидающие данные из сокета, но не ждёт поступления новых данных. В случае успеха возвращает количество прочитанных байтов. Поскольку try_read() работает в неблокирующем режиме, буфер не нужно хранить в асинхронной задаче: он может полностью находиться в стеке.

Обычно вместе с этой функцией используется readable() или ready().

Возвращаемое значение

Если данные успешно прочитаны, возвращается Ok(n), где n — количество прочитанных байтов. Если n равно 0, это может указывать на один из двух сценариев:

1. Читающая половина потока закрыта и больше не будет выдавать данные.
2. Длина указанного буфера равна 0 байтам.

Если поток не готов к чтению данных, возвращается Err(io::ErrorKind::WouldBlock).

Пытается прочитать данные из потока в предоставленные буферы и возвращает количество прочитанных байтов.

Данные копируются в буферы по порядку; последний заполняемый буфер может быть заполнен лишь частично. Этот метод эквивалентен однократному вызову try_read() с объединёнными буферами.

Получает все ожидающие данные из сокета, но не ждёт поступления новых данных. В случае успеха возвращает количество прочитанных байтов. Поскольку try_read_vectored() работает в неблокирующем режиме, буфер не нужно хранить в асинхронной задаче: он может полностью находиться в стеке.

Обычно вместе с этой функцией используется readable() или ready().

Возвращаемое значение

Если данные успешно прочитаны, возвращается Ok(n), где n — количество прочитанных байтов. Ok(0) означает, что читающая половина потока закрыта и больше не будет выдавать данные. Если поток не готов к чтению данных, возвращается Err(io::ErrorKind::WouldBlock).

Пытается прочитать данные из потока в предоставленный буфер, сдвигая его внутренний курсор, и возвращает количество прочитанных байтов.

Получает все ожидающие данные из сокета, но не ждёт поступления новых данных. В случае успеха возвращает количество прочитанных байтов. Поскольку try_read_buf() работает в неблокирующем режиме, буфер не нужно хранить в асинхронной задаче: он может полностью находиться в стеке.

Обычно вместе с этой функцией используется readable() или ready().

Возвращаемое значение

Если данные успешно прочитаны, возвращается Ok(n), где n — количество прочитанных байтов. Ok(0) означает, что читающая половина потока закрыта и больше не будет выдавать данные. Если поток не готов к чтению данных, возвращается Err(io::ErrorKind::WouldBlock).

Возвращает удалённый адрес, к которому подключён этот поток.

Возвращает локальный адрес, к которому привязан этот поток.

Возвращает аргумент без изменений.

Вызывает U::from(self).

То есть результат преобразования определяется тем, что выберет сделать реализация From<T> for U.