rustix 1.1.2

Safe Rust bindings to POSIX/Unix/Linux/Winsock-like syscalls
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

use super::Flock;
use crate::fd::AsFd;
use crate::{backend, io};

/// `fcntl(fd, F_GETLK)`—Get the first lock that blocks the lock description
/// pointed to by the argument `lock`. If no such lock is found, then `None` is
/// returned.
///
/// If `lock.typ` is set to `FlockType::Unlocked`, the returned value/error is
/// not explicitly defined, as per POSIX, and will depend on the underlying
/// platform implementation.
///
/// # References
///  - [POSIX]
///  - [Linux]
///
/// [POSIX]: https://pubs.opengroup.org/onlinepubs/9799919799/functions/fcntl.html
/// [Linux]: https://man7.org/linux/man-pages/man2/fcntl.2.html
#[inline]
#[doc(alias = "F_GETLK")]
pub fn fcntl_getlk<Fd: AsFd>(fd: Fd, lock: &Flock) -> io::Result<Option<Flock>> {
    backend::process::syscalls::fcntl_getlk(fd.as_fd(), lock)
}