Skip to main content

Promise

Enum Promise 

Source
pub enum Promise {
    Off,
    Blocks,
}
Expand description

Whether the restrict contract is checked, from -fsafety-restrict.

Design: spec/safe-memory/09-type-init-and-races.md section 9.6, which is row Y8 of document 03 and is judgement J8. C 6.7.3.1 says that if an object reachable through a restrict pointer declared in a block is modified anywhere in that block, every access to that object in that block goes through that pointer. Nothing about one access decides it, which is why document 04 section 4.6 keeps it out of J1.

A flag rather than a default for two reasons, and neither of them is the one Subobject has. The first is cost, and it is a bad distribution rather than a large number: an access inside a block that declares restrict pointers pays a scan of that block’s record, and blocks that declare them are the numeric kernels and the mem functions, which is exactly where the hot loops are. Code with no restrict in it pays nothing at all. The second is that the record is the union of what each pointer reached, so two pointers striding through one array without ever landing on the same byte are reported, and by the letter of the standard those are different objects and that is not a violation.

The second one is not an imprecision to apologise for. This check exists because a violated restrict is a miscompilation, and what the optimizer acts on is that the ranges are disjoint, so a program the union rule reports is a program the optimizer is entitled to break. It is still a report about a program the standard permits, which is a decision that belongs to the build rather than to this compiler.

Variants§

§

Off

No -fsafety-restrict. An access says which restrict pointer it went through, because the alias analysis reads that, and nothing asks whether two of them met.

§

Blocks

-fsafety-restrict. Every block that declares restrict pointers keeps a record of what each of them reached, and every access through one asks whether another got there first.

Implementations§

Source§

impl Promise

Source

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

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

Source

pub const fn checks(self) -> bool

Whether a block keeps a record and an access asks about it.

Trait Implementations§

Source§

impl Clone for Promise

Source§

fn clone(&self) -> Promise

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Promise

Source§

impl Debug for Promise

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Promise

Source§

fn default() -> Promise

Returns the “default value” for a type. Read more
Source§

impl Display for Promise

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Promise

Source§

impl Hash for Promise

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Promise

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for Promise

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Promise

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Promise

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.