Struct nix::sys::select::FdSet

#[repr(transparent)]
pub struct FdSet<'fd> { /* private fields */ }

Available on crate feature poll only.

Contains a set of file descriptors used by select

Implementations

impl<'fd> FdSet<'fd>

pub fn new() -> FdSet<'fd>

Create an empty FdSet

pub fn insert<Fd: AsFd>(&mut self, fd: &'fd Fd)

Add a file descriptor to an FdSet

pub fn remove<Fd: AsFd>(&mut self, fd: &'fd Fd)

Remove a file descriptor from an FdSet

pub fn contains<Fd: AsFd>(&self, fd: &'fd Fd) -> bool

Test an FdSet for the presence of a certain file descriptor.

pub fn clear(&mut self)

Remove all file descriptors from this FdSet.

pub fn highest(&self) -> Option<BorrowedFd<'_>>

Finds the highest file descriptor in the set.

Returns None if the set is empty.

This can be used to calculate the nfds parameter of the select function.

Example

let fd_four = unsafe {BorrowedFd::borrow_raw(4)};
let fd_nine = unsafe {BorrowedFd::borrow_raw(9)};
let mut set = FdSet::new();
set.insert(&fd_four);
set.insert(&fd_nine);
assert_eq!(set.highest().map(|borrowed_fd|borrowed_fd.as_raw_fd()), Some(9));

pub fn fds(&self, highest: Option<RawFd>) -> Fds<'_, '_>

Returns an iterator over the file descriptors in the set.

For performance, it takes an optional higher bound: the iterator will not return any elements of the set greater than the given file descriptor.

Examples

let mut set = FdSet::new();
let fd_four = unsafe {BorrowedFd::borrow_raw(4)};
let fd_nine = unsafe {BorrowedFd::borrow_raw(9)};
set.insert(&fd_four);
set.insert(&fd_nine);
let fds: Vec<RawFd> = set.fds(None).map(|borrowed_fd|borrowed_fd.as_raw_fd()).collect();
assert_eq!(fds, vec![4, 9]);

Trait Implementations

impl<'fd> Clone for FdSet<'fd>

fn clone(&self) -> FdSet<'fd>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'fd> Debug for FdSet<'fd>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'fd> Default for FdSet<'fd>

fn default() -> Self

Returns the “default value” for a type.

impl<'fd> Hash for FdSet<'fd>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'fd> PartialEq<FdSet<'fd>> for FdSet<'fd>

fn eq(&self, other: &FdSet<'fd>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'fd> Copy for FdSet<'fd>

impl<'fd> Eq for FdSet<'fd>

impl<'fd> StructuralEq for FdSet<'fd>

impl<'fd> StructuralPartialEq for FdSet<'fd>