# rlimit

[![Latest Version]][crates.io]
[![Documentation]][docs.rs]
![License]

Resource limits

[crates.io]: https://crates.io/crates/rlimit
[Latest Version]: https://img.shields.io/crates/v/rlimit.svg
[Documentation]: https://docs.rs/rlimit/badge.svg
[docs.rs]: https://docs.rs/rlimit
[License]: https://img.shields.io/crates/l/rlimit.svg

## Examples
### Set resource limit

```rust
use rlimit::{setrlimit, Resource};

const DEFAULT_SOFT_LIMIT: u64 = 4 * 1024 * 1024;
const DEFAULT_HARD_LIMIT: u64 = 8 * 1024 * 1024;
assert!(Resource::FSIZE.set(DEFAULT_SOFT_LIMIT, DEFAULT_HARD_LIMIT).is_ok());

let soft = 16384;
let hard = soft * 2;
assert!(setrlimit(Resource::NOFILE, soft, hard).is_ok());
```
### Get resource limit

```rust
use rlimit::{getrlimit, Resource};

assert!(Resource::NOFILE.get().is_ok());
assert_eq!(getrlimit(Resource::CPU).unwrap(), (rlimit::INFINITY, rlimit::INFINITY));
```

### Increase NOFILE limit

See the example [nofile](https://github.com/Nugine/rlimit/tree/v0.6.2/examples/nofile.rs).

You can also use the tools in `rlimit::utils`.

```rust
use rlimit::utils::increase_nofile_limit;
increase_nofile_limit(10240).unwrap();
increase_nofile_limit(u64::MAX).unwrap();
```

## Troubleshoot
### Failed to increase NOFILE to hard limit on macOS

On macOS, getrlimit by default reports that the hard limit is
unlimited, but there is usually a stricter hard limit discoverable
via sysctl (`kern.maxfilesperproc`). Failing to discover this secret stricter hard limit will
cause the call to setrlimit to fail.

`rlimit::utils::increase_nofile_limit` respects `kern.maxfilesperproc`.