Enum Safety 

pub enum Safety {
    Off,
    Detect,
    Enforce,
    Kernel,
}

How much of the memory safety monitor is on, from -fsafety=.

Design: spec/safe-memory/15-integration.md section 15.4. One flag rather than a plane at a time, because the tiers of spec/safe-memory/02-threat-model.md are the product and the modifiers are how somebody who has read that document departs from one.

The tiers agree about which accesses are checked and disagree about what happens when a check says no and about how much of the boundary is covered. That is why they are one value here and not three booleans: a build asks for a tier, and everything else follows from it.

Variants

Off

-fsafety=off. No checks and no runtime. The default, and what every existing build gets.

Detect

-fsafety=detect. Tier D: report and carry on, for a test run or a fuzzer.

Enforce

-fsafety=enforce. Tier E: report and stop, for a program that faces the network.

Kernel

-fsafety=kernel. Tier K: what a kernel can afford, with the allocator and the libc wrappers taken out because a kernel has neither.

Implementations

impl Safety

pub const fn as_str(self) -> &'static str

The spelling this tier is asked for by, without the flag in front of it.

pub const fn instruments(self) -> bool

Whether checks are inserted at all.

The three tiers that are not off all insert the same checks at this milestone. What separates them is the reporter and the boundary, which are milestones S2 and S3 in spec/safe-memory/16-milestones.md.

Trait Implementations

impl Clone for Safety

fn clone(&self) -> Safety

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Safety

impl Debug for Safety

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

Formats the value using the given formatter.

impl Default for Safety

fn default() -> Safety

Returns the “default value” for a type.

impl Display for Safety

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

Formats the value using the given formatter.

impl Eq for Safety

impl FromStr for Safety

fn from_str(s: &str) -> Result<Self, ()>

Parses the part after -fsafety=.

type Err = ()

The associated error which can be returned from parsing.

impl Hash for Safety

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Safety

fn cmp(&self, other: &Safety) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Safety

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Safety

fn partial_cmp(&self, other: &Safety) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Safety