Struct rlimit::Resource

pub struct Resource { /* fields omitted */ }

A kind of resource.

Be careful: The documentation of Resource constants are based on Linux and FreeBSD. It may be inconsistent with other platforms.

References

Linux: https://man7.org/linux/man-pages/man2/getrlimit.2.html

FreeBSD: https://www.freebsd.org/cgi/man.cgi?query=getrlimit

Implementations

impl Resource

pub const AS: Self

The maximum size (in bytes) of the process's virtual memory (address space).

pub const CORE: Self

The maximum size (in bytes) of a core file that the process may dump.

pub const CPU: Self

A limit (in seconds) on the amount of CPU time that the process can consume.

pub const DATA: Self

The maximum size (in bytes) of the process's data segment (initialized data, uninitialized data, and heap).

pub const FSIZE: Self

The maximum size (in bytes) of files that the process may create.

pub const MEMLOCK: Self

The maximum number (in bytes) of memory that may be locked into RAM.

pub const NOFILE: Self

This specifies a value one greater than the maximum file descriptor number that can be opened by this process.

pub const NPROC: Self

A limit on the number of extant process (or, more precisely on Linux, threads) for the real user ID of the calling process.

pub const RSS: Self

A limit (in bytes) on the process's resident set (the number of virtual pages resident in RAM).

pub const STACK: Self

The maximum size (in bytes) of the process stack.

impl Resource

pub fn set(self, soft: Rlim, hard: Rlim) -> Result<()>

Set resource limits.

Errors

See setrlimit

pub fn get(self) -> Result<(Rlim, Rlim)>

Get resource limits.

Errors

See getrlimit

#[must_use]pub fn as_name(self) -> &'static str

Returns the name of the resource.

Example

assert_eq!(Resource::NOFILE.as_name(), "RLIMIT_NOFILE");

#[must_use]pub const fn available_names() -> &'static [&'static str]

Returns available resource names.

#[must_use]pub const fn available_resources() -> &'static [Self]

Returns available resources.

#[must_use]pub const fn as_raw(self) -> RawResource

Returns the raw resource type.

Be careful: The actual type of RawResource can be different on different platforms.

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Resource

impl Debug for Resource

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

Formats the value using the given formatter.

impl Eq for Resource

impl FromStr for Resource

type Err = ParseResourceError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Resource

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Resource> for Resource

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

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

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

This method tests for !=.

impl StructuralEq for Resource

impl StructuralPartialEq for Resource