Skip to content

Commit 2dc7235

Browse files
ThomasdezeeuwThomasdezeeuw
committed
Fix various doc attributes
1 parent 4b5728c commit 2dc7235

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

‎src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ impl Type {
261261
///
262262
/// Used for the DCCP protocol.
263263
#[cfg(all(feature = "all", target_os = "linux"))]
264-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
264+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
265265
pub const DCCP: Type = Type(sys::SOCK_DCCP);
266266

267267
/// Type corresponding to `SOCK_SEQPACKET`.
@@ -316,7 +316,7 @@ impl Protocol {
316316

317317
/// Protocol corresponding to `DCCP`.
318318
#[cfg(all(feature = "all", target_os = "linux"))]
319-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
319+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
320320
pub const DCCP: Protocol = Protocol(sys::IPPROTO_DCCP);
321321

322322
#[cfg(all(feature = "all", any(target_os = "freebsd", target_os = "linux")))]

‎src/socket.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ impl Socket {
367367
///
368368
/// On Windows it is not possible retrieve the nonblocking mode status.
369369
#[cfg(all(feature = "all", unix))]
370-
#[cfg_attr(docsrs, doc(all(feature = "all", unix)))]
370+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", unix))))]
371371
pub fn nonblocking(&self) -> io::Result<bool> {
372372
sys::nonblocking(self.as_raw())
373373
}
@@ -1084,7 +1084,7 @@ impl Socket {
10841084
///
10851085
/// [`set_header_included`]: Socket::set_header_included
10861086
#[cfg(all(feature = "all", not(target_os = "redox")))]
1087-
#[cfg_attr(docsrs, doc(all(feature = "all", not(target_os = "redox"))))]
1087+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "redox")))))]
10881088
pub fn header_included(&self) -> io::Result<bool> {
10891089
unsafe {
10901090
getsockopt::<c_int>(self.as_raw(), sys::IPPROTO_IP, sys::IP_HDRINCL)
@@ -1104,7 +1104,7 @@ impl Socket {
11041104
/// [`IP_TTL`]: Socket::set_ttl
11051105
/// [`IP_TOS`]: Socket::set_tos
11061106
#[cfg(all(feature = "all", not(target_os = "redox")))]
1107-
#[cfg_attr(docsrs, doc(all(feature = "all", not(target_os = "redox"))))]
1107+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", not(target_os = "redox")))))]
11081108
pub fn set_header_included(&self, included: bool) -> io::Result<()> {
11091109
unsafe {
11101110
setsockopt(

‎src/sys/unix.rs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2428,7 +2428,7 @@ impl crate::Socket {
24282428
/// [`connect`]: crate::Socket::connect
24292429
/// [`bind`]: crate::Socket::bind
24302430
#[cfg(all(feature = "all", target_os = "linux"))]
2431-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2431+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24322432
pub fn set_dccp_service(&self, code: u32) -> io::Result<()> {
24332433
unsafe {
24342434
setsockopt(
@@ -2446,7 +2446,7 @@ impl crate::Socket {
24462446
///
24472447
/// [`set_dccp_service`]: crate::Socket::set_dccp_service
24482448
#[cfg(all(feature = "all", target_os = "linux"))]
2449-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2449+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24502450
pub fn dccp_service(&self) -> io::Result<u32> {
24512451
unsafe { getsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_SERVICE) }
24522452
}
@@ -2455,7 +2455,7 @@ impl crate::Socket {
24552455
///
24562456
/// This option sets both the TX and RX CCIDs at the same time.
24572457
#[cfg(all(feature = "all", target_os = "linux"))]
2458-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2458+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24592459
pub fn set_dccp_ccid(&self, ccid: u8) -> io::Result<()> {
24602460
unsafe { setsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_CCID, ccid) }
24612461
}
@@ -2466,7 +2466,7 @@ impl crate::Socket {
24662466
///
24672467
/// [`set_dccp_ccid`]: crate::Socket::set_dccp_ccid
24682468
#[cfg(all(feature = "all", target_os = "linux"))]
2469-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2469+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24702470
pub fn dccp_tx_ccid(&self) -> io::Result<u32> {
24712471
unsafe { getsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_TX_CCID) }
24722472
}
@@ -2477,7 +2477,7 @@ impl crate::Socket {
24772477
///
24782478
/// [`set_dccp_ccid`]: crate::Socket::set_dccp_ccid
24792479
#[cfg(all(feature = "all", target_os = "linux"))]
2480-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2480+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24812481
pub fn dccp_xx_ccid(&self) -> io::Result<u32> {
24822482
unsafe { getsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_RX_CCID) }
24832483
}
@@ -2487,7 +2487,7 @@ impl crate::Socket {
24872487
/// Enables a listening socket to hold timewait state when closing the
24882488
/// connection. This option must be set after `accept` returns.
24892489
#[cfg(all(feature = "all", target_os = "linux"))]
2490-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2490+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
24912491
pub fn set_dccp_server_timewait(&self, hold_timewait: bool) -> io::Result<()> {
24922492
unsafe {
24932493
setsockopt(
@@ -2505,7 +2505,7 @@ impl crate::Socket {
25052505
///
25062506
/// [`set_dccp_server_timewait`]: crate::Socket::set_dccp_server_timewait
25072507
#[cfg(all(feature = "all", target_os = "linux"))]
2508-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2508+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25092509
pub fn dccp_server_timewait(&self) -> io::Result<bool> {
25102510
unsafe {
25112511
getsockopt(
@@ -2524,7 +2524,7 @@ impl crate::Socket {
25242524
/// accepted by the receiver. Hence, when using this feature on the sender,
25252525
/// it must be enabled at the receiver too, with suitable choice of CsCov.
25262526
#[cfg(all(feature = "all", target_os = "linux"))]
2527-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2527+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25282528
pub fn set_dccp_send_cscov(&self, level: u32) -> io::Result<()> {
25292529
unsafe {
25302530
setsockopt(
@@ -2542,7 +2542,7 @@ impl crate::Socket {
25422542
///
25432543
/// [`set_dccp_send_cscov`]: crate::Socket::set_dccp_send_cscov
25442544
#[cfg(all(feature = "all", target_os = "linux"))]
2545-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2545+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25462546
pub fn dccp_send_cscov(&self) -> io::Result<u32> {
25472547
unsafe { getsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_SEND_CSCOV) }
25482548
}
@@ -2553,7 +2553,7 @@ impl crate::Socket {
25532553
///
25542554
/// [`set_dccp_send_cscov`]: crate::Socket::set_dccp_send_cscov
25552555
#[cfg(all(feature = "all", target_os = "linux"))]
2556-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2556+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25572557
pub fn set_dccp_recv_cscov(&self, level: u32) -> io::Result<()> {
25582558
unsafe {
25592559
setsockopt(
@@ -2571,7 +2571,7 @@ impl crate::Socket {
25712571
///
25722572
/// [`set_dccp_recv_cscov`]: crate::Socket::set_dccp_recv_cscov
25732573
#[cfg(all(feature = "all", target_os = "linux"))]
2574-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2574+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25752575
pub fn dccp_recv_cscov(&self) -> io::Result<u32> {
25762576
unsafe { getsockopt(self.as_raw(), libc::SOL_DCCP, libc::DCCP_SOCKOPT_RECV_CSCOV) }
25772577
}
@@ -2581,7 +2581,7 @@ impl crate::Socket {
25812581
/// This option sets the maximum length of the output queue. A zero value is
25822582
/// interpreted as unbounded queue length.
25832583
#[cfg(all(feature = "all", target_os = "linux"))]
2584-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2584+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
25852585
pub fn set_dccp_qpolicy_txqlen(&self, length: u32) -> io::Result<()> {
25862586
unsafe {
25872587
setsockopt(
@@ -2599,7 +2599,7 @@ impl crate::Socket {
25992599
///
26002600
/// [`set_dccp_qpolicy_txqlen`]: crate::Socket::set_dccp_qpolicy_txqlen
26012601
#[cfg(all(feature = "all", target_os = "linux"))]
2602-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2602+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
26032603
pub fn dccp_qpolicy_txqlen(&self) -> io::Result<u32> {
26042604
unsafe {
26052605
getsockopt(
@@ -2620,7 +2620,7 @@ impl crate::Socket {
26202620
///
26212621
/// [documentation]: https://www.kernel.org/doc/html/latest/networking/dccp.html
26222622
#[cfg(all(feature = "all", target_os = "linux"))]
2623-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2623+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
26242624
pub fn dccp_available_ccids<const N: usize>(&self) -> io::Result<CcidEndpoints<N>> {
26252625
let mut endpoints = [0; N];
26262626
let mut length = endpoints.len() as libc::socklen_t;
@@ -2639,7 +2639,7 @@ impl crate::Socket {
26392639
/// This option retrieves the current maximum packet size (application
26402640
/// payload size) in bytes.
26412641
#[cfg(all(feature = "all", target_os = "linux"))]
2642-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2642+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
26432643
pub fn dccp_cur_mps(&self) -> io::Result<u32> {
26442644
unsafe {
26452645
getsockopt(
@@ -2653,15 +2653,15 @@ impl crate::Socket {
26532653

26542654
/// See [`Socket::dccp_available_ccids`].
26552655
#[cfg(all(feature = "all", target_os = "linux"))]
2656-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2656+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
26572657
#[derive(Debug)]
26582658
pub struct CcidEndpoints<const N: usize> {
26592659
endpoints: [u8; N],
26602660
length: u32,
26612661
}
26622662

26632663
#[cfg(all(feature = "all", target_os = "linux"))]
2664-
#[cfg_attr(docsrs, doc(cfg(feature = "all", target_os = "linux")))]
2664+
#[cfg_attr(docsrs, doc(cfg(all(feature = "all", target_os = "linux"))))]
26652665
impl<const N: usize> std::ops::Deref for CcidEndpoints<N> {
26662666
type Target = [u8];
26672667

0 commit comments

Comments
 (0)