Better documentation
This commit is contained in:
parent
907008df66
commit
0ce9662f52
13
Cargo.toml
13
Cargo.toml
|
@ -19,3 +19,16 @@ notify = ["dep:libc", "dep:rustix"]
|
||||||
libc = { version = "0.2.150", optional = true }
|
libc = { version = "0.2.150", optional = true }
|
||||||
rustix = { version = "0.38.26", optional = true, features = ["net"] }
|
rustix = { version = "0.38.26", optional = true, features = ["net"] }
|
||||||
tracing = { version = "0.1.40", default-features = false, features = ["std", "log"] }
|
tracing = { version = "0.1.40", default-features = false, features = ["std", "log"] }
|
||||||
|
|
||||||
|
[package.metadata.docs.rs]
|
||||||
|
features = ["listenfd", "notify"]
|
||||||
|
rustdoc-args = ["--cfg", "doc_cfg"]
|
||||||
|
targets = [
|
||||||
|
"x86_64-unknown-linux-gnu",
|
||||||
|
"i686-unknown-linux-gnu",
|
||||||
|
"x86_64-apple-darwin",
|
||||||
|
"x86_64-unknown-freebsd",
|
||||||
|
"x86_64-unknown-openbsd",
|
||||||
|
"x86_64-unknown-netbsd",
|
||||||
|
"wasm32-unknown-emscripten"
|
||||||
|
]
|
||||||
|
|
|
@ -1,4 +1,10 @@
|
||||||
|
//! A library permitting interaction with the LISTEN_FDS and NOTIFY_SOCKET protocol.
|
||||||
|
|
||||||
|
#![cfg_attr(doc_cfg, feature(doc_cfg))]
|
||||||
|
|
||||||
#[cfg(feature = "listenfd")]
|
#[cfg(feature = "listenfd")]
|
||||||
|
#[cfg_attr(doc_cfg, doc(cfg(feature = "listenfd")))]
|
||||||
pub mod listen;
|
pub mod listen;
|
||||||
#[cfg(feature = "notify")]
|
#[cfg(feature = "notify")]
|
||||||
|
#[cfg_attr(doc_cfg, doc(cfg(feature = "notify")))]
|
||||||
pub mod notify;
|
pub mod notify;
|
||||||
|
|
|
@ -104,7 +104,7 @@ impl FileDescriptor {
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// This function will fail if no file descriptor colud be received which might not actually be an error. See [`ReceiveError`] for details.
|
/// This function will fail if no file descriptor could be received which might not actually be an error. See [`ReceiveError`] for details.
|
||||||
pub fn receive(
|
pub fn receive(
|
||||||
unset_env: bool,
|
unset_env: bool,
|
||||||
) -> Result<impl IntoIterator<Item = Result<Self, DupError>>, ReceiveError> {
|
) -> Result<impl IntoIterator<Item = Result<Self, DupError>>, ReceiveError> {
|
||||||
|
@ -127,7 +127,7 @@ impl FileDescriptor {
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// This function will fail if no file descriptor colud be received which might not actually be an error. See [`ReceiveError`] for details.
|
/// This function will fail if no file descriptor could be received which might not actually be an error. See [`ReceiveError`] for details.
|
||||||
///
|
///
|
||||||
/// # Safety
|
/// # Safety
|
||||||
///
|
///
|
||||||
|
|
Loading…
Reference in a new issue