Struct rctl::Rule

pub struct Rule {
    pub subject: Subject,
    pub resource: Resource,
    pub limit: Limit,
    pub action: Action,
}

A rule represents an [Action] to be taken when a particular [Subject] hits a [Limit] for a [Resource].

Syntax for the string representation of a rule is subject:subject-id:resource:action=amount/per.

Examples

use rctl::{Subject, SubjectType, Resource, Action, Limit, Rule};
let rule = Rule {
    subject: Subject::user_name("nobody").expect("no user 'nobody'"),
    resource: Resource::VMemoryUse,
    action: Action::Deny,
    limit: Limit::amount(1024*1024*1024),
};

assert_eq!(rule.to_string(), "user:nobody:vmemoryuse:deny=1g".to_string());

Fields

subject: Subject

resource: Resource

limit: Limit

action: Action

Implementations

impl Rule

pub fn to_string(&self) -> String

pub fn apply(&self) -> Result<(), Error>

Add this rule to the resource limits database.

Example

use rctl::{Rule, Subject, Resource, Action, Limit};

let rule = Rule {
    subject: Subject::jail_name("testjail_rctl_rule_apply_method"),
    resource: Resource::VMemoryUse,
    action: Action::Log,
    limit: Limit::amount(100*1024*1024),
};

rule.apply();

pub fn remove(&self) -> Result<(), Error>

Attempt to remove this rule from the resource limits database.

Example

use rctl::{Rule, Subject, Resource, Action, Limit};

let rule = Rule {
    subject: Subject::jail_name("testjail_rctl_rule_remove_method"),
    resource: Resource::VMemoryUse,
    action: Action::Log,
    limit: Limit::amount(100*1024*1024),
};

rule.remove();

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl Display for Rule

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

Formats the value using the given formatter.

impl Eq for Rule

impl<'a> From<&'a Rule> for Filter

fn from(rule: &'a Rule) -> Self

Performs the conversion.

impl From<Rule> for Filter

fn from(rule: Rule) -> Self

Performs the conversion.

impl FromStr for Rule

type Err = ParseError

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 Rule

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<'a> Into<String> for &'a Rule

fn into(self) -> String

Performs the conversion.

impl PartialEq<Rule> for Rule

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

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

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

This method tests for !=.

impl StructuralEq for Rule

impl StructuralPartialEq for Rule