Struct Resource

Source

pub struct Resource { /* private fields */ }

Expand description

A kind of resource.

All resource constants are available on all unix platforms. Passing an unsupported resource to [set|get|p]rlimit will result in a custom IO error.

Be careful: The documentation of Resource constants are based on a few systems. 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

NetBSD: https://man.netbsd.org/getrlimit.2

Implementations§

Source §

impl Resource

Source

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

Set resource limits.

§Errors

See setrlimit

Source

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

Get resource limits.

§Errors

See getrlimit

Source

pub fn as_name(self) -> &'static str

Returns the name of the resource.

§Example

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

Source

pub const fn is_supported(self) -> bool

Returns true if the current platform supports this resource.

Source §

impl Resource

Source

pub const AS: Self = _

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

Source

pub const CORE: Self = _

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

Source

pub const CPU: Self = _

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

Source

pub const DATA: Self = _

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

Source

pub const FSIZE: Self = _

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

Source

pub const KQUEUES: Self = _

The maximum number of kqueues this user id is allowed to create.

Source

pub const LOCKS: Self = _

(early Linux 2.4 only)

A limit on the combined number of flock(2) locks and fcntl(2) leases that this process may establish.

Source

pub const MEMLOCK: Self = _

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

Source

pub const MSGQUEUE: Self = _

A limit on the number of bytes that can be allocated for POSIX message queues for the real user ID of the calling process.

Source

pub const NICE: Self = _

This specifies a ceiling to which the process’s nice value can be raised using setpriority(2) or nice(2).

Source

pub const NOFILE: Self = _

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

Source

pub const NOVMON: Self = _

The number of open vnode monitors.

Source

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.

Source

pub const NPTS: Self = _

The maximum number of pseudo-terminals this user id is allowed to create.

Source

pub const NTHR: Self = _

The maximum number of simultaneous threads (Lightweight Processes) for this user id. Kernel threads and the first thread of each process are not counted against this limit.

Source

pub const POSIXLOCKS: Self = _

The maximum number of POSIX-type advisory-mode locks available to this user.

Source

pub const RSS: Self = _

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

Source

pub const RTPRIO: Self = _

This specifies a ceiling on the real-time priority that may be set for this process using sched_setscheduler(2) and sched_setparam(2).

Source

pub const RTTIME: Self = _

A limit (in microseconds) on the amount of CPU time that a process scheduled under a real-time scheduling policy may consume without making a blocking system call.

Source

pub const SBSIZE: Self = _

The maximum size (in bytes) of socket buffer usage for this user. This limits the amount of network memory, and hence the amount of mbufs, that this user may hold at any time.

Source