Module ops

Overloadable operators.

Implementing these traits allows you to overload certain operators.

Some of these traits are imported by the prelude, so they are available in every Rust program. Only operators backed by traits can be overloaded. For example, the addition operator (+) can be overloaded through the Add trait, but since the assignment operator (=) has no backing trait, there is no way of overloading its semantics. Additionally, this module does not provide any mechanism to create new operators. If traitless overloading or custom operators are required, you should look toward macros to extend Rust’s syntax.

Implementations of operator traits should be unsurprising in their respective contexts, keeping in mind their usual meanings and operator precedence. For example, when implementing Mul, the operation should have some resemblance to multiplication (and share expected properties like associativity).

Note that the && and || operators are currently not supported for overloading. Due to their short circuiting nature, they require a different design from traits for other operators like BitAnd. Designs for them are under discussion.

Many of the operators take their operands by value. In non-generic contexts involving built-in types, this is usually not a problem. However, using these operators in generic code, requires some attention if values have to be reused as opposed to letting the operators consume them. One option is to occasionally use clone. Another option is to rely on the types involved providing additional operator implementations for references. For example, for a user-defined type T which is supposed to support addition, it is probably a good idea to have both T and &T implement the traits Add<T> and Add<&T> so that generic code can be written without unnecessary cloning.

Examples

This example creates a Point struct that implements Add and Sub, and then demonstrates adding and subtracting two Points.

use std::ops::{Add, Sub};

#[derive(Debug, Copy, Clone, PartialEq)]
struct Point {
    x: i32,
    y: i32,
}

impl Add for Point {
    type Output = Self;

    fn add(self, other: Self) -> Self {
        Self {x: self.x + other.x, y: self.y + other.y}
    }
}

impl Sub for Point {
    type Output = Self;

    fn sub(self, other: Self) -> Self {
        Self {x: self.x - other.x, y: self.y - other.y}
    }
}

assert_eq!(Point {x: 3, y: 3}, Point {x: 1, y: 0} + Point {x: 2, y: 3});
assert_eq!(Point {x: -1, y: -3}, Point {x: 1, y: 0} - Point {x: 2, y: 3});

See the documentation for each trait for an example implementation.

The Fn, FnMut, and FnOnce traits are implemented by types that can be invoked like functions. Note that Fn takes &self, FnMut takes &mut self and FnOnce takes self. These correspond to the three kinds of methods that can be invoked on an instance: call-by-reference, call-by-mutable-reference, and call-by-value. The most common use of these traits is to act as bounds to higher-level functions that take functions or closures as arguments.

Taking a Fn as a parameter:

fn call_with_one<F>(func: F) -> usize
    where F: Fn(usize) -> usize
{
    func(1)
}

let double = |x| x * 2;
assert_eq!(call_with_one(double), 2);

Taking a FnMut as a parameter:

fn do_twice<F>(mut func: F)
    where F: FnMut()
{
    func();
    func();
}

let mut x: usize = 1;
{
    let add_two_to_x = || x += 2;
    do_twice(add_two_to_x);
}

assert_eq!(x, 5);

Taking a FnOnce as a parameter:

fn consume_with_relish<F>(func: F)
    where F: FnOnce() -> String
{
    // `func` consumes its captured variables, so it cannot be run more
    // than once
    println!("Consumed: {}", func());

    println!("Delicious!");

    // Attempting to invoke `func()` again will throw a `use of moved
    // value` error for `func`
}

let x = String::from("x");
let consume_and_return_x = move || x;
consume_with_relish(consume_and_return_x);

// `consume_and_return_x` can no longer be invoked at this point

Re-exports

pub use self::arith::Add;

pub use self::arith::Div;

pub use self::arith::Mul;

pub use self::arith::Neg;

pub use self::arith::Rem;

pub use self::arith::Sub;

pub use self::arith::AddAssign;

pub use self::arith::DivAssign;

pub use self::arith::MulAssign;

pub use self::arith::RemAssign;

pub use self::arith::SubAssign;

pub use self::bit::BitAnd;

pub use self::bit::BitOr;

pub use self::bit::BitXor;

pub use self::bit::Not;

pub use self::bit::Shl;

pub use self::bit::Shr;

pub use self::bit::BitAndAssign;

pub use self::bit::BitOrAssign;

pub use self::bit::BitXorAssign;

pub use self::bit::ShlAssign;

pub use self::bit::ShrAssign;

pub use self::control_flow::ControlFlow;

pub use self::deref::Deref;

pub use self::deref::DerefMut;

pub use self::drop::Drop;

pub use self::function::Fn;

pub use self::function::FnMut;

pub use self::function::FnOnce;

pub use self::index::Index;

pub use self::index::IndexMut;

pub use self::range::Bound;

pub use self::range::RangeBounds;

pub use self::range::RangeInclusive;

pub use self::range::RangeToInclusive;

pub use self::range::Range;

pub use self::range::RangeFrom;

pub use self::range::RangeFull;

pub use self::range::RangeTo;

pub use self::async_function::AsyncFn;

pub use self::async_function::AsyncFnMut;

pub use self::async_function::AsyncFnOnce;

pub use self::coroutine::Coroutine;Experimental

pub use self::coroutine::CoroutineState;Experimental

pub use self::deref::DerefPure;Experimental

pub use self::deref::LegacyReceiver;Experimental

pub use self::deref::Receiver;Experimental

pub use self::range::IntoBounds;Experimental

pub use self::range::OneSidedRange;Experimental

pub use self::range::OneSidedRangeBound;Experimental

pub use self::try_trait::Residual;Experimental

pub use self::try_trait::Yeet;Experimental

pub use self::try_trait::FromResidual;Experimental

pub use self::try_trait::Try;Experimental

pub use self::unsize::CoerceUnsized;Experimental

pub use self::unsize::DispatchFromDyn;Experimental

Modules

arith 🔒

async_function 🔒

bit 🔒

control_flow 🔒

coroutine 🔒

deref 🔒

drop 🔒

function 🔒

index 🔒

index_range 🔒

range 🔒

try_trait 🔒

unsize 🔒