Add feature annotation to docs of Channel::send_vectored()

jmillikin · Aug 21, 2020 · d093303 · d093303
1 parent ced54bb
commit d093303
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/fuse/src/channel.rs b/fuse/src/channel.rs
@@ -24,12 +24,13 @@ use std::io::{self, IoSlice, Read, Write};
 
 use crate::error::{Error, ErrorCode};
 
-#[cfg(feature = "nightly_impl_channel")]
+#[cfg(any(doc, feature = "nightly_impl_channel"))]
 pub trait Channel {
 	type Error: ChannelError;
 
 	fn send(&self, buf: &[u8]) -> Result<(), Self::Error>;
 
+	#[cfg_attr(doc, doc(cfg(feature = "nightly_impl_channel")))]
 	fn send_vectored<const N: usize>(
 		&self,
 		bufs: &[&[u8]; N],
@@ -47,7 +48,7 @@ pub(crate) mod private {
 	}
 }
 
-#[cfg(not(feature = "nightly_impl_channel"))]
+#[cfg(not(any(doc, feature = "nightly_impl_channel")))]
 pub trait Channel:
 	private::ChannelNoConstGenerics<<Self as Channel>::Error>
 {
@@ -163,7 +164,8 @@ impl Channel for FileChannel {
 		Ok(())
 	}
 
-	#[cfg(feature = "nightly_impl_channel")]
+	#[cfg(any(doc, feature = "nightly_impl_channel"))]
+
 	fn send_vectored<const N: usize>(
 		&self,
 		bufs: &[&[u8]; N],

diff --git a/fuse/src/lib.rs b/fuse/src/lib.rs
@@ -23,7 +23,10 @@
 
 // For `send_vectored` in `fuse/src/channel.rs`.
 #![allow(incomplete_features)]
-#![cfg_attr(feature = "nightly_impl_channel", feature(const_generics))]
+#![cfg_attr(any(
+	doc,
+	feature = "nightly_impl_channel",
+), feature(const_generics))]
 
 #[cfg(feature = "libc_fuse_mount")]
 extern crate libc;

diff --git a/fuse/src/os/linux/dev_cuse_channel.rs b/fuse/src/os/linux/dev_cuse_channel.rs
@@ -51,7 +51,7 @@ impl channel::Channel for DevCuseChannel {
 		self.0.send(buf)
 	}
 
-	#[cfg(feature = "nightly_impl_channel")]
+	#[cfg(any(doc, feature = "nightly_impl_channel"))]
 	fn send_vectored<const N: usize>(
 		&self,
 		bufs: &[&[u8]; N],

diff --git a/fuse/src/os/linux/dev_fuse_channel.rs b/fuse/src/os/linux/dev_fuse_channel.rs
@@ -51,7 +51,7 @@ impl channel::Channel for DevFuseChannel {
 		self.0.send(buf)
 	}
 
-	#[cfg(feature = "nightly_impl_channel")]
+	#[cfg(any(doc, feature = "nightly_impl_channel"))]
 	fn send_vectored<const N: usize>(
 		&self,
 		bufs: &[&[u8]; N],