Skip to content

Lack of documentation regarding cancel safety on TcpStream::peek #7303

Open
@cvengler

Description

@cvengler

Version
latest

Platform
Documentation related

Description
Some methods in TcpStream contain a note regarding their cancel safety, such as TcpStream::readable. However, this information is not present with the TcpStream::peek method. The only reference I could find there, is that it uses the recv system call with the MSG_PEEK argument, potentially referring the user to dig into the abyss of the respective Unix manual pages.

I expected to see this happen: A subsection on cancel safety for the TcpStream::peek method.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-tokioArea: The main tokio crateC-bugCategory: This is a bug.M-netModule: tokio/netT-docsTopic: documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions