Skip to content

Commit e2e9a08

Browse files
sunfishcodesunfishcode
authored
Add doc aliases for bind, connect, and send_to functions. (#326)
Functions corresponding to bind, connect, and send_to have different names in cap-std, so give them doc aliases to make them easier to find and make the correspondence more clear.
1 parent 4e92198 commit e2e9a08

File tree

6 files changed

+33
-2
lines changed

6 files changed

+33
-2
lines changed

‎cap-async-std/src/fs/dir.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -662,6 +662,7 @@ impl Dir {
662662
/// XXX: This function is not yet implemented.
663663
///
664664
/// [`async_std::os::unix::net::UnixListener::bind`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixListener.html#method.bind
665+
#[doc(alias = "bind")]
665666
#[cfg(unix)]
666667
#[inline]
667668
pub async fn bind_unix_listener<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixListener> {
@@ -680,6 +681,7 @@ impl Dir {
680681
/// XXX: This function is not yet implemented.
681682
///
682683
/// [`async_std::os::unix::net::UnixStream::connect`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixStream.html#method.connect
684+
#[doc(alias = "connect")]
683685
#[cfg(unix)]
684686
#[inline]
685687
pub async fn connect_unix_stream<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixStream> {
@@ -698,6 +700,7 @@ impl Dir {
698700
/// XXX: This function is not yet implemented.
699701
///
700702
/// [`async_std::os::unix::net::UnixDatagram::bind`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.bind
703+
#[doc(alias = "bind")]
701704
#[cfg(unix)]
702705
#[inline]
703706
pub async fn bind_unix_datagram<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixDatagram> {
@@ -717,6 +720,7 @@ impl Dir {
717720
/// XXX: This function is not yet implemented.
718721
///
719722
/// [`async_std::os::unix::net::UnixDatagram::connect`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.connect
723+
#[doc(alias = "connect")]
720724
#[cfg(unix)]
721725
#[inline]
722726
pub async fn connect_unix_datagram<P: AsRef<Path>>(
@@ -740,6 +744,7 @@ impl Dir {
740744
/// XXX: This function is not yet implemented.
741745
///
742746
/// [`async_std::os::unix::net::UnixDatagram::send_to`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.send_to
747+
#[doc(alias = "send_to")]
743748
#[cfg(unix)]
744749
#[inline]
745750
pub async fn send_to_unix_datagram_addr<P: AsRef<Path>>(

‎cap-async-std/src/fs_utf8/dir.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -457,6 +457,7 @@ impl Dir {
457457
/// XXX: This function is not yet implemented.
458458
///
459459
/// [`async_std::os::unix::net::UnixListener::bind`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixListener.html#method.bind
460+
#[doc(alias = "bind")]
460461
#[cfg(unix)]
461462
#[inline]
462463
pub async fn bind_unix_listener<P: AsRef<Utf8Path>>(
@@ -475,6 +476,7 @@ impl Dir {
475476
/// XXX: This function is not yet implemented.
476477
///
477478
/// [`async_std::os::unix::net::UnixStream::connect`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixStream.html#method.connect
479+
#[doc(alias = "connect")]
478480
#[cfg(unix)]
479481
#[inline]
480482
pub async fn connect_unix_stream<P: AsRef<Utf8Path>>(&self, path: P) -> io::Result<UnixStream> {
@@ -490,6 +492,7 @@ impl Dir {
490492
/// XXX: This function is not yet implemented.
491493
///
492494
/// [`async_std::os::unix::net::UnixDatagram::bind`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.bind
495+
#[doc(alias = "bind")]
493496
#[cfg(unix)]
494497
#[inline]
495498
pub async fn bind_unix_datagram<P: AsRef<Utf8Path>>(
@@ -509,6 +512,7 @@ impl Dir {
509512
/// XXX: This function is not yet implemented.
510513
///
511514
/// [`async_std::os::unix::net::UnixDatagram::connect`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.connect
515+
#[doc(alias = "connect")]
512516
#[cfg(unix)]
513517
#[inline]
514518
pub async fn connect_unix_datagram<P: AsRef<Utf8Path>>(
@@ -531,6 +535,7 @@ impl Dir {
531535
/// XXX: This function is not yet implemented.
532536
///
533537
/// [`async_std::os::unix::net::UnixDatagram::send_to`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.send_to
538+
#[doc(alias = "send_to")]
534539
#[cfg(unix)]
535540
#[inline]
536541
pub async fn send_to_unix_datagram_addr<P: AsRef<Utf8Path>>(

‎cap-async-std/src/net/pool.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ impl Pool {
105105
/// address.
106106
///
107107
/// This corresponds to [`async_std::net::TcpListener::bind`].
108+
#[doc(alias = "bind")]
108109
#[inline]
109110
pub async fn bind_tcp_listener<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpListener> {
110111
let addrs = addr.to_socket_addrs().await?;
@@ -127,6 +128,7 @@ impl Pool {
127128
/// Creates a new TCP stream connected to the specified address.
128129
///
129130
/// This corresponds to [`async_std::net::TcpStream::connect`].
131+
#[doc(alias = "connect")]
130132
#[inline]
131133
pub async fn connect_tcp_stream<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpStream> {
132134
let addrs = addr.to_socket_addrs().await?;
@@ -151,6 +153,7 @@ impl Pool {
151153
/// Creates a UDP socket from the given address.
152154
///
153155
/// This corresponds to [`async_std::net::UdpSocket::bind`].
156+
#[doc(alias = "bind")]
154157
#[inline]
155158
pub async fn bind_udp_socket<A: ToSocketAddrs>(&self, addr: A) -> io::Result<UdpSocket> {
156159
let addrs = addr.to_socket_addrs().await?;
@@ -172,6 +175,7 @@ impl Pool {
172175
/// Sends data on the socket to the given address.
173176
///
174177
/// This corresponds to [`async_std::net::UdpSocket::send_to`].
178+
#[doc(alias = "send_to")]
175179
#[inline]
176180
pub async fn send_to_udp_socket_addr<A: ToSocketAddrs>(
177181
&self,
@@ -193,6 +197,7 @@ impl Pool {
193197
/// Connects the UDP socket to a remote address.
194198
///
195199
/// This corresponds to [`async_std::net::UdpSocket::connect`].
200+
#[doc(alias = "connect")]
196201
#[inline]
197202
pub async fn connect_udp_socket<A: ToSocketAddrs>(
198203
&self,

‎cap-std/src/fs/dir.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,7 @@ impl Dir {
478478
/// XXX: This function is not yet implemented.
479479
///
480480
/// [`std::os::unix::net::UnixListener::bind`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind
481+
#[doc(alias = "bind")]
481482
#[cfg(unix)]
482483
#[inline]
483484
pub fn bind_unix_listener<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixListener> {
@@ -496,6 +497,7 @@ impl Dir {
496497
/// XXX: This function is not yet implemented.
497498
///
498499
/// [`std::os::unix::net::UnixStream::connect`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixStream.html#method.connect
500+
#[doc(alias = "connect")]
499501
#[cfg(unix)]
500502
#[inline]
501503
pub fn connect_unix_stream<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixStream> {
@@ -514,6 +516,7 @@ impl Dir {
514516
/// XXX: This function is not yet implemented.
515517
///
516518
/// [`std::os::unix::net::UnixDatagram::bind`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind
519+
#[doc(alias = "bind")]
517520
#[cfg(unix)]
518521
#[inline]
519522
pub fn bind_unix_datagram<P: AsRef<Path>>(&self, path: P) -> io::Result<UnixDatagram> {
@@ -532,6 +535,7 @@ impl Dir {
532535
/// XXX: This function is not yet implemented.
533536
///
534537
/// [`std::os::unix::net::UnixDatagram::connect`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.connect
538+
#[doc(alias = "connect")]
535539
#[cfg(unix)]
536540
#[inline]
537541
pub fn connect_unix_datagram<P: AsRef<Path>>(
@@ -554,6 +558,7 @@ impl Dir {
554558
/// XXX: This function is not yet implemented.
555559
///
556560
/// [`std::os::unix::net::UnixDatagram::send_to`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.send_to
561+
#[doc(alias = "send_to")]
557562
#[cfg(unix)]
558563
#[inline]
559564
pub fn send_to_unix_datagram_addr<P: AsRef<Path>>(

‎cap-std/src/fs_utf8/dir.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,7 @@ impl Dir {
448448
/// XXX: This function is not yet implemented.
449449
///
450450
/// [`std::os::unix::net::UnixListener::bind`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind
451+
#[doc(alias = "bind")]
451452
#[cfg(unix)]
452453
#[inline]
453454
pub fn bind_unix_listener<P: AsRef<Utf8Path>>(&self, path: P) -> io::Result<UnixListener> {
@@ -463,6 +464,7 @@ impl Dir {
463464
/// XXX: This function is not yet implemented.
464465
///
465466
/// [`std::os::unix::net::UnixStream::connect`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixStream.html#method.connect
467+
#[doc(alias = "connect")]
466468
#[cfg(unix)]
467469
#[inline]
468470
pub fn connect_unix_stream<P: AsRef<Utf8Path>>(&self, path: P) -> io::Result<UnixStream> {
@@ -478,6 +480,7 @@ impl Dir {
478480
/// XXX: This function is not yet implemented.
479481
///
480482
/// [`std::os::unix::net::UnixDatagram::bind`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind
483+
#[doc(alias = "bind")]
481484
#[cfg(unix)]
482485
#[inline]
483486
pub fn bind_unix_datagram<P: AsRef<Utf8Path>>(&self, path: P) -> io::Result<UnixDatagram> {
@@ -493,6 +496,7 @@ impl Dir {
493496
/// XXX: This function is not yet implemented.
494497
///
495498
/// [`std::os::unix::net::UnixDatagram::connect`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.connect
499+
#[doc(alias = "connect")]
496500
#[cfg(unix)]
497501
#[inline]
498502
pub fn connect_unix_datagram<P: AsRef<Utf8Path>>(
@@ -512,6 +516,7 @@ impl Dir {
512516
/// XXX: This function is not yet implemented.
513517
///
514518
/// [`std::os::unix::net::UnixDatagram::send_to`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.send_to
519+
#[doc(alias = "send_to")]
515520
#[cfg(unix)]
516521
#[inline]
517522
pub fn send_to_unix_datagram_addr<P: AsRef<Utf8Path>>(

‎cap-std/src/net/pool.rs‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ impl Pool {
4747

4848
/// Add a specific [`net::SocketAddr`] to the pool.
4949
///
50-
/// # AmbientAuthority
50+
/// # Ambient Authority
5151
///
5252
/// This function allows ambient access to any IP address.
5353
pub fn insert_socket_addr(
@@ -96,7 +96,7 @@ impl Pool {
9696

9797
/// Add a range of network addresses with a specific port to the pool.
9898
///
99-
/// # AmbientAuthority
99+
/// # Ambient Authority
100100
///
101101
/// This function allows ambient access to any IP address.
102102
pub fn insert_ip_net(
@@ -112,6 +112,7 @@ impl Pool {
112112
/// address.
113113
///
114114
/// This corresponds to [`std::net::TcpListener::bind`].
115+
#[doc(alias = "bind")]
115116
#[inline]
116117
pub fn bind_tcp_listener<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpListener> {
117118
let addrs = addr.to_socket_addrs()?;
@@ -134,6 +135,7 @@ impl Pool {
134135
/// Opens a TCP connection to a remote host.
135136
///
136137
/// This corresponds to [`std::net::TcpStream::connect`].
138+
#[doc(alias = "connect")]
137139
#[inline]
138140
pub fn connect_tcp_stream<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpStream> {
139141
let addrs = addr.to_socket_addrs()?;
@@ -156,6 +158,7 @@ impl Pool {
156158
/// Opens a TCP connection to a remote host with a timeout.
157159
///
158160
/// This corresponds to [`std::net::TcpStream::connect_timeout`].
161+
#[doc(alias = "connect")]
159162
#[inline]
160163
pub fn connect_timeout_tcp_stream(
161164
&self,
@@ -170,6 +173,7 @@ impl Pool {
170173
/// Creates a UDP socket from the given address.
171174
///
172175
/// This corresponds to [`std::net::UdpSocket::bind`].
176+
#[doc(alias = "bind")]
173177
#[inline]
174178
pub fn bind_udp_socket<A: ToSocketAddrs>(&self, addr: A) -> io::Result<UdpSocket> {
175179
let addrs = addr.to_socket_addrs()?;
@@ -192,6 +196,7 @@ impl Pool {
192196
/// number of bytes written.
193197
///
194198
/// This corresponds to [`std::net::UdpSocket::send_to`].
199+
#[doc(alias = "send_to")]
195200
#[inline]
196201
pub fn send_to_udp_socket_addr<A: ToSocketAddrs>(
197202
&self,
@@ -212,6 +217,7 @@ impl Pool {
212217
/// only receive data from the specified address.
213218
///
214219
/// This corresponds to [`std::net::UdpSocket::connect`].
220+
#[doc(alias = "connect")]
215221
#[inline]
216222
pub fn connect_udp_socket<A: ToSocketAddrs>(
217223
&self,

0 commit comments

Comments
 (0)