limits-rs 0.1.0

//! Utilities for determining the limits that an operating system enforce on a given particular
//! process.
//!
//! In its current implementation, this crate allows convenient read of the `/proc/<pid>/limits`
//! file on GNU/Linux. On any other platform, the provided methods will return an error so that the
//! user can decide what to do in the absence of information about limits.
//!
//! Support for other operating systems and platforms may be added on demand.

#[macro_use]
extern crate failure_derive;

// Support for GNU/Linux
#[cfg(target_os = "linux")]
mod linux;
#[cfg(target_os = "linux")]
pub use crate::linux::*;

// Placeholder for all other platforms
#[cfg(not(target_os = "linux"))]
mod default;
#[cfg(not(target_os = "linux"))]
pub use crate::default::*;

/// All methods that can fail in this crate should return `Result<_, Error>`. That is, one of the
/// variants herein.
#[derive(Debug, Fail)]
pub enum Error {
    #[fail(display = "Unsupported OS. Could not get process limits.")]
    UnsupportedOS,
    #[fail(display = "Proc file not found at `{}`: {}", _0, _1)]
    ProcFileNotFound(String, #[cause] std::io::Error),
}

/// Get the limits for the process in which we are running (our own process id).
pub fn get_own_limits() -> Result<Limits, crate::Error> {
    let own_pid = std::process::id();

    get_pid_limits(own_pid)
}