Struct jail::StoppedJail

pub struct StoppedJail {
    pub path: Option<PathBuf>,
    pub name: Option<String>,
    pub hostname: Option<String>,
    pub params: HashMap<String, Value>,
    pub ips: Vec<IpAddr>,
    pub limits: Vec<(Resource, Limit, Action)>,
}

Represent a stopped jail including all information required to start it

Fields

path: Option<PathBuf>

The path of root file system of the jail

name: Option<String>

The jail name

hostname: Option<String>

The jail hostname

params: HashMap<String, Value>

A hashmap of jail parameters and their values

ips: Vec<IpAddr>

A list of IP (v4 and v6) addresses to be assigned to this jail

limits: Vec<(Resource, Limit, Action)>

A list of resource limits

Implementations

impl StoppedJail

pub fn new<P: Into<PathBuf> + Debug>(path: P) -> StoppedJail

Create a new Jail instance given a path.

Examples

use jail::StoppedJail;

let j = StoppedJail::new("/rescue");

pub fn start(self: StoppedJail) -> Result<RunningJail, JailError>

Start the jail

This will call jail_create internally. This will consume the StoppedJail and return a Result<RunningJail,Error>.

Examples

use jail::StoppedJail;

let stopped = StoppedJail::new("/rescue");
let running = stopped.start().unwrap();

pub fn name<S: Into<String> + Debug>(self, name: S) -> Self

Set the jail name

Examples

let mut stopped = StoppedJail::new("/rescue")
    .name("test_stopped_name");

assert_eq!(stopped.name, Some("test_stopped_name".to_string()));

pub fn hostname<S: Into<String> + Debug>(self, hostname: S) -> Self

Set the jail name

Examples

let mut stopped = StoppedJail::new("/rescue")
    .hostname("example.com");

assert_eq!(stopped.hostname, Some("example.com".to_string()));

pub fn param<S: Into<String> + Debug>(self, param: S, value: Value) -> Self

Set a jail parameter

Examples

use jail::param;

let mut stopped = StoppedJail::new("/rescue")
    .param("allow.raw_sockets", param::Value::Int(1));

pub fn limit(self, resource: Resource, limit: Limit, action: Action) -> Self

Set a resource limit

Examples

extern crate rctl;
use rctl;
let mut stopped = StoppedJail::new("/rescue").limit(
    rctl::Resource::MemoryUse,
    rctl::Limit::amount_per(100 * 1024 * 1024, rctl::SubjectType::Process),
    rctl::Action::Deny,
);

pub fn ip(self, ip: IpAddr) -> Self

Add an IP Address

Examples

let mut stopped = StoppedJail::new("rescue")
    .ip("127.0.1.1".parse().expect("could not parse 127.0.1.1"))
    .ip("fe80::2".parse().expect("could not parse ::1"));

Trait Implementations

impl Clone for StoppedJail

fn clone(&self) -> StoppedJail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoppedJail

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

Formats the value using the given formatter.

impl Default for StoppedJail

fn default() -> StoppedJail

Returns the "default value" for a type.

impl Eq for StoppedJail

impl From<StoppedJail> for Jail

fn from(stopped: StoppedJail) -> Self

Performs the conversion.

impl PartialEq<StoppedJail> for StoppedJail

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

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

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

This method tests for !=.

impl StructuralEq for StoppedJail

impl StructuralPartialEq for StoppedJail

impl TryFrom<RunningJail> for StoppedJail

type Error = JailError

The type returned in the event of a conversion error.

fn try_from(running: RunningJail) -> Result<StoppedJail, Self::Error>

Performs the conversion.

impl TryFrom<StoppedJail> for RunningJail

type Error = JailError

The type returned in the event of a conversion error.

fn try_from(stopped: StoppedJail) -> Result<RunningJail, Self::Error>

Performs the conversion.