Skip to main content

OpenFileList

Struct OpenFileList 

Source
pub struct OpenFileList { /* private fields */ }
Expand description

The descriptors of one process, as far as the listing cap allowed.

The fields are private because the two of them have an invariant: not_listed is exactly the number of descriptors the cap left out, and a caller that could set them independently could claim a complete listing of a process it truncated. OpenFileList::listed is the only constructor, and it enforces both the cap and the arithmetic.

Implementations§

Source§

impl OpenFileList

Source

pub const MAX_LISTED: usize = 256

The largest number of descriptors any collector will list paths for.

Resolving a path costs one syscall per descriptor on both platforms — a proc_pidfdinfo on macOS, a readlink on Linux — and a process can hold tens of thousands, so §16.1’s “nothing unbounded” applies even on the on-demand tier of §8.6. 256 was measured at 0.9 µs per descriptor on an M4 Pro (216 µs for the 244 vnodes of a 442-descriptor process), which bounds the whole walk at well under a millisecond, and it is far more rows than the overlay can show without scrolling for a while.

Source

pub fn listed(entries: Vec<OpenFileEntry>, total: usize) -> Self

A listing of entries taken from a descriptor table of total entries.

entries is truncated to OpenFileList::MAX_LISTED and everything the cap left out is counted, so the panel can say how many descriptors it did not list rather than presenting a partial list as a complete one (§4).

Source

pub fn entries(&self) -> &[OpenFileEntry]

The descriptors that were listed.

Source

pub fn count(&self) -> usize

How many descriptors were listed.

Source

pub const fn not_listed(&self) -> u32

How many descriptors the cap left out.

Source

pub fn total(&self) -> u64

How many descriptors the process held when it was walked.

Source

pub const fn is_complete(&self) -> bool

Whether every descriptor was listed.

Trait Implementations§

Source§

impl Clone for OpenFileList

Source§

fn clone(&self) -> OpenFileList

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenFileList

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OpenFileList

Source§

fn default() -> OpenFileList

Returns the “default value” for a type. Read more
Source§

impl Eq for OpenFileList

Source§

impl PartialEq for OpenFileList

Source§

fn eq(&self, other: &OpenFileList) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OpenFileList

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.