# Enum rustc_middle::mir::BinOp

``````pub enum BinOp {
Sub,
SubUnchecked,
Mul,
MulUnchecked,
Div,
Rem,
BitXor,
BitAnd,
BitOr,
Shl,
ShlUnchecked,
Shr,
ShrUnchecked,
Eq,
Lt,
Le,
Ne,
Ge,
Gt,
Cmp,
Offset,
}``````

## Variants§

§

The `+` operator (addition)

§

Like `Add`, but with UB on overflow. (Integers only.)

§

### Sub

The `-` operator (subtraction)

§

### SubUnchecked

Like `Sub`, but with UB on overflow. (Integers only.)

§

### Mul

The `*` operator (multiplication)

§

### MulUnchecked

Like `Mul`, but with UB on overflow. (Integers only.)

§

### Div

The `/` operator (division)

For integer types, division by zero is UB, as is `MIN / -1` for signed. The compiler should have inserted checks prior to this.

Floating-point division by zero is safe, and does not need guards.

§

### Rem

The `%` operator (modulus)

For integer types, using zero as the modulus (second operand) is UB, as is `MIN % -1` for signed. The compiler should have inserted checks prior to this.

Floating-point remainder by zero is safe, and does not need guards.

§

### BitXor

The `^` operator (bitwise xor)

§

### BitAnd

The `&` operator (bitwise and)

§

### BitOr

The `|` operator (bitwise or)

§

### Shl

The `<<` operator (shift left)

The offset is (uniquely) determined as follows:

• it is “equal modulo LHS::BITS” to the RHS
• it is in the range `0..LHS::BITS`
§

### ShlUnchecked

Like `Shl`, but is UB if the RHS >= LHS::BITS or RHS < 0

§

### Shr

The `>>` operator (shift right)

The offset is (uniquely) determined as follows:

• it is “equal modulo LHS::BITS” to the RHS
• it is in the range `0..LHS::BITS`

This is an arithmetic shift if the LHS is signed and a logical shift if the LHS is unsigned.

§

### ShrUnchecked

Like `Shl`, but is UB if the RHS >= LHS::BITS or RHS < 0

§

### Eq

The `==` operator (equality)

§

### Lt

The `<` operator (less than)

§

### Le

The `<=` operator (less than or equal to)

§

### Ne

The `!=` operator (not equal to)

§

### Ge

The `>=` operator (greater than or equal to)

§

### Gt

The `>` operator (greater than)

§

### Cmp

The `<=>` operator (three-way comparison, like `Ord::cmp`)

This is supported only on the integer types and `char`, always returning `rustc_hir::LangItem::OrderingEnum` (aka `std::cmp::Ordering`).

`Rvalue::BinaryOp``(BinOp::Cmp, A, B)` returns

• `Ordering::Less` (`-1_i8`, as a Scalar) if `A < B`
• `Ordering::Equal` (`0_i8`, as a Scalar) if `A == B`
• `Ordering::Greater` (`+1_i8`, as a Scalar) if `A > B`
§

### Offset

The `ptr.offset` operator

source§

source

source§

source

## Trait Implementations§

source§

### impl Clone for BinOp

source§

#### fn clone(&self) -> BinOp

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for BinOp

source§

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

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

source§

source§

source§

source§

### impl Hash for BinOp

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§

source§

source§

### impl Ord for BinOp

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

#### fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

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

### impl PartialEq for BinOp

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl PartialOrd for BinOp

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
source§

### impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for BinOp

source§

#### fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F ) -> Result<Self, __F::Error>

The entry point for folding. To fold a value `t` with a folder `f` call: `t.try_fold_with(f)`. Read more
source§

#### fn fold_with<F>(self, folder: &mut F) -> Selfwhere F: TypeFolder<I>,

A convenient alternative to `try_fold_with` for use with infallible folders. Do not override this method, to ensure coherence with `try_fold_with`.
source§

### impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for BinOp

source§

#### fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V ) -> __V::Result

The entry point for visiting. To visit a value `t` with a visitor `v` call: `t.visit_with(v)`. Read more
source§

source§

source§

§

§

§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Aligned for T

source§

#### const ALIGN: Alignment = _

Alignment of `Self`.
source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T, R> CollectAndApply<T, R> for T

source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> Rwhere I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

§

source§

### impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn compare(&self, key: &K) -> Ordering

Compare self to `key` and return their ordering.
source§

### impl<Tcx, T> DepNodeParams<Tcx> for Twhere Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

source§

source§

#### default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
source§

source§

#### default fn recover(_: Tcx, _: &DepNode) -> Option<T>

This method tries to recover the query key from the given `DepNode`, something which is needed when forcing `DepNode`s during red-green evaluation. The query system will only call this method if `fingerprint_style()` is not `FingerprintStyle::Opaque`. It is always valid to return `None` here, in which case incremental compilation will treat the query as having changed instead of forcing it.
source§

### impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

### impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

### impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> Filterable for T

source§

#### fn filterable( self, filter_name: &'static str ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T> Instrument for T

source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for Twhere 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> IntoEither for T

source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
source§

source§

source§

### impl<'tcx, T> IsSuggestable<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,

source§

#### fn is_suggestable(self, tcx: TyCtxt<'tcx>, infer_suggestable: bool) -> bool

Whether this makes sense to suggest in a diagnostic. Read more
source§

source§

§

source§

source§

source§

### impl<T> Pointable for T

source§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### 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, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### 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.
source§

### impl<I, T> TypeVisitableExt<I> for Twhere I: Interner, T: TypeVisitable<I>,

source§

source§

#### fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns `true` if `self` has any late-bound regions that are either bound by `binder` or bound by some binder outside of `binder`. If `binder` is `ty::INNERMOST`, this indicates whether there are any late-bound regions that appear free.
source§

source§

#### fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns `true` if this type has any regions that escape `binder` (and hence are not bound by it).
source§

#### fn has_escaping_bound_vars(&self) -> bool

Return `true` if this type has regions that are not a part of the type. For example, `for<'a> fn(&'a i32)` return `false`, while `fn(&'a i32)` would return `true`. The latter can occur when traversing through the former. Read more
source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

#### fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.
source§

source§

#### fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
source§

#### fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.
source§

#### fn has_bound_regions(&self) -> bool

True if there are any late-bound regions
source§

#### fn has_non_region_bound_vars(&self) -> bool

True if there are any late-bound non-region variables
source§

#### fn has_bound_vars(&self) -> bool

True if there are any bound variables
source§

#### fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of `impl` specialization.
source§

source§

source§

source§

source§

source§

source§

source§

source§

### impl<T> WithSubscriber for T

source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

source§

source§

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• `Add`: 0 bytes
• `AddUnchecked`: 0 bytes
• `Sub`: 0 bytes
• `SubUnchecked`: 0 bytes
• `Mul`: 0 bytes
• `MulUnchecked`: 0 bytes
• `Div`: 0 bytes
• `Rem`: 0 bytes
• `BitXor`: 0 bytes
• `BitAnd`: 0 bytes
• `BitOr`: 0 bytes
• `Shl`: 0 bytes
• `ShlUnchecked`: 0 bytes
• `Shr`: 0 bytes
• `ShrUnchecked`: 0 bytes
• `Eq`: 0 bytes
• `Lt`: 0 bytes
• `Le`: 0 bytes
• `Ne`: 0 bytes
• `Ge`: 0 bytes
• `Gt`: 0 bytes
• `Cmp`: 0 bytes
• `Offset`: 0 bytes