mod.rs.html -- source
Description: Source to the Rust file `src/libcore/ops/mod.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199

    //! 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 or compiler
    //! plugins 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 short-circuit, i.e., they only
    //! evaluate their second operand if it contributes to the result. Since this
    //! behavior is not enforceable by traits, `&&` and `||` are not supported as
    //! overloadable operators.
    //!
    //! 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>`][`Add`] and
    //! [`Add<&T>`][`Add`] 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 `Point`s.
    //!
    //! ```rust
    //! use std::ops::{Add, Sub};
    //!
    //! #[derive(Debug, PartialEq)]
    //! struct Point {
    //!     x: i32,
    //!     y: i32,
    //! }
    //!
    //! impl Add for Point {
    //!     type Output = Point;
    //!
    //!     fn add(self, other: Point) -> Point {
    //!         Point {x: self.x + other.x, y: self.y + other.y}
    //!     }
    //! }
    //!
    //! impl Sub for Point {
    //!     type Output = Point;
    //!
    //!     fn sub(self, other: Point) -> Point {
    //!         Point {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:
    //!
    //! ```rust
    //! 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:
    //!
    //! ```rust
    //! 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:
    //!
    //! ```rust
    //! 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
    //! ```
    //!
    //! [`Fn`]: trait.Fn.html
    //! [`FnMut`]: trait.FnMut.html
    //! [`FnOnce`]: trait.FnOnce.html
    //! [`Add`]: trait.Add.html
    //! [`Sub`]: trait.Sub.html
    //! [`Mul`]: trait.Mul.html
    //! [`clone`]: ../clone/trait.Clone.html#tymethod.clone
    //! [operator precedence]: ../../reference/expressions.html#expression-precedence

    #![stable(feature = "rust1", since = "1.0.0")]

    mod arith;
    mod bit;
    mod deref;
    mod drop;
    mod function;
    mod generator;
    mod index;
    mod range;
    mod r#try;
    mod unsize;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::arith::{Add, Div, Mul, Neg, Rem, Sub};
    #[stable(feature = "op_assign_traits", since = "1.8.0")]
    pub use self::arith::{AddAssign, DivAssign, MulAssign, RemAssign, SubAssign};

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::bit::{BitAnd, BitOr, BitXor, Not, Shl, Shr};
    #[stable(feature = "op_assign_traits", since = "1.8.0")]
    pub use self::bit::{BitAndAssign, BitOrAssign, BitXorAssign, ShlAssign, ShrAssign};

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::deref::{Deref, DerefMut};

    #[unstable(feature = "receiver_trait", issue = "0")]
    pub use self::deref::Receiver;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::drop::Drop;

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::function::{Fn, FnMut, FnOnce};

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::index::{Index, IndexMut};

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::range::{Range, RangeFrom, RangeFull, RangeTo};

    #[stable(feature = "inclusive_range", since = "1.26.0")]
    pub use self::range::{Bound, RangeBounds, RangeInclusive, RangeToInclusive};

    #[unstable(feature = "try_trait", issue = "42327")]
    pub use self::r#try::Try;

    #[unstable(feature = "generator_trait", issue = "43122")]
    pub use self::generator::{Generator, GeneratorState};

    #[unstable(feature = "coerce_unsized", issue = "27732")]
    pub use self::unsize::CoerceUnsized;

    #[unstable(feature = "dispatch_from_dyn", issue = "0")]
    pub use self::unsize::DispatchFromDyn;