itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-28 12:10:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: fix cfg!(miri) declarations in tests (#7286)

Browse Source
This commit is contained in:
Alice Ryhl 2025-04-24 14:50:19 +02:00 committed by GitHub
parent 4d4d12613b
commit 1ea9ce11d4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 28 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tokio/src/net/tcp/listener.rs
View File

@ -84,13 +84,12 @@ impl TcpListener {
/// # Examples
///
/// ```no_run
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use tokio::net::TcpListener;
///
/// use std::io;
///
/// #[tokio::main]
/// async fn main() -> io::Result<()> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let listener = TcpListener::bind("127.0.0.1:2345").await?;
///
/// // use the listener

2
tokio/src/net/tcp/socket.rs
View File

@ -743,12 +743,12 @@ impl TcpSocket {
/// # Examples
///
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use tokio::net::TcpSocket;
/// use socket2::{Domain, Socket, Type};
///
/// #[tokio::main]
/// async fn main() -> std::io::Result<()> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let socket2_socket = Socket::new(Domain::IPV4, Type::STREAM, None)?;
/// socket2_socket.set_nonblocking(true)?;
///

2
tokio/src/net/tcp/stream.rs
View File

@ -220,7 +220,6 @@ impl TcpStream {
/// # Examples
///
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use std::error::Error;
/// use std::io::Read;
/// use tokio::net::TcpListener;
@ -229,6 +228,7 @@ impl TcpStream {
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let mut data = [0u8; 12];
/// # if false {
/// let listener = TcpListener::bind("127.0.0.1:34254").await?;

6
tokio/src/net/udp.rs
View File

@ -135,12 +135,12 @@ impl UdpSocket {
/// # Example
///
/// ```no_run
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use tokio::net::UdpSocket;
/// use std::io;
///
/// #[tokio::main]
/// async fn main() -> io::Result<()> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let sock = UdpSocket::bind("0.0.0.0:8080").await?;
/// // use `sock`
/// # let _ = sock;
@ -303,12 +303,12 @@ impl UdpSocket {
/// # Example
///
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use tokio::net::UdpSocket;
///
/// # use std::{io, net::SocketAddr};
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let addr = "0.0.0.0:8080".parse::<SocketAddr>().unwrap();
/// let peer = "127.0.0.1:11100".parse::<SocketAddr>().unwrap();
/// let sock = UdpSocket::bind(addr).await?;
@ -2130,12 +2130,12 @@ impl UdpSocket {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use tokio::net::UdpSocket;
/// use std::io;
///
/// #[tokio::main]
/// async fn main() -> io::Result<()> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// // Create a socket
/// let socket = UdpSocket::bind("0.0.0.0:8080").await?;
///

38
tokio/src/net/unix/datagram/socket.rs
View File

@ -36,10 +36,10 @@ cfg_net_unix! {
/// # Examples
/// Using named sockets, associated with a filesystem path:
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -69,10 +69,10 @@ cfg_net_unix! {
///
/// Using unnamed sockets, created as a pair
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -374,10 +374,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -407,10 +407,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -466,10 +466,10 @@ impl UnixDatagram {
/// explicitly with [`Runtime::enter`](crate::runtime::Runtime::enter) function.
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use std::os::unix::net::UnixDatagram as StdUDS;
/// use tempfile::tempdir;
@ -533,10 +533,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -573,10 +573,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -618,10 +618,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -749,10 +749,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -900,10 +900,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -1017,10 +1017,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -1068,10 +1068,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -1119,10 +1119,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -1436,10 +1436,10 @@ impl UnixDatagram {
/// # Examples
/// For a socket bound to a local path
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -1459,10 +1459,10 @@ impl UnixDatagram {
///
/// For an unbound socket
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create an unbound socket
@ -1484,10 +1484,10 @@ impl UnixDatagram {
/// # Examples
/// For a peer with a local path
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
/// use tempfile::tempdir;
///
@ -1510,10 +1510,10 @@ impl UnixDatagram {
///
/// For an unbound peer
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create the pair of sockets
@ -1532,10 +1532,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// use tokio::net::UnixDatagram;
///
/// // Create an unbound socket
@ -1560,10 +1560,10 @@ impl UnixDatagram {
///
/// # Examples
/// ```
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
/// # use std::error::Error;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
/// use tokio::net::UnixDatagram;
/// use std::net::Shutdown;
///

2
tokio/src/net/unix/stream.rs
View File

@ -840,7 +840,6 @@ impl UnixStream {
/// # Examples
///
/// ```
/// # if cfg!(miri) { return } // No `socket` in miri.
/// use std::error::Error;
/// use std::io::Read;
/// use tokio::net::UnixListener;
@ -849,6 +848,7 @@ impl UnixStream {
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
/// let dir = tempfile::tempdir().unwrap();
/// let bind_path = dir.path().join("bind_path");
///

3
tokio/src/process/mod.rs
View File

@ -810,7 +810,6 @@ impl Command {
/// Basic usage:
///
/// ```no_run
/// # if cfg!(miri) { return } // No `pidfd_spawnp` in miri.
/// use tokio::process::Command;
///
/// async fn run_ls() -> std::process::ExitStatus {
@ -1347,7 +1346,6 @@ impl Child {
/// This function is cancel safe.
///
/// ```
/// # if cfg!(miri) { return } // No `pidfd_spawnp` in miri.
/// # #[cfg(not(unix))]fn main(){}
/// # #[cfg(unix)]
/// use tokio::io::AsyncWriteExt;
@ -1359,6 +1357,7 @@ impl Child {
/// # #[cfg(unix)]
/// #[tokio::main]
/// async fn main() {
/// # if cfg!(miri) { return; } // No `pidfd_spawnp` in miri.
/// let mut child = Command::new("cat")
/// .stdin(Stdio::piped())
/// .spawn()

2
tokio/src/runtime/runtime.rs
View File

@ -407,7 +407,6 @@ impl Runtime {
/// # Examples
///
/// ```
/// # if cfg!(miri) { return } // Miri reports error when main thread terminated without waiting all remaining threads.
/// use tokio::runtime::Runtime;
/// use tokio::task;
///
@ -415,6 +414,7 @@ impl Runtime {
/// use std::time::Duration;
///
/// fn main() {
/// # if cfg!(miri) { return } // Miri reports error when main thread terminated without waiting all remaining threads.
/// let runtime = Runtime::new().unwrap();
///
/// runtime.block_on(async move {