-
Notifications
You must be signed in to change notification settings - Fork 13.3k
TRPL: operators and overloading #24725
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bors
merged 1 commit into
rust-lang:master
from
steveklabnik:doc_operators_and_overloading
Apr 25, 2015
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,83 @@ | ||
% Operators and Overloading | ||
|
||
Coming soon! | ||
Rust allows for a limited form of operator overloading. There are certain | ||
operators that are able to be overloaded. To support a particular operator | ||
between types, there’s a specific trait that you can implement, which then | ||
overloads the operator. | ||
|
||
For example, the `+` operator can be overloaded with the `Add` trait: | ||
|
||
```rust | ||
use std::ops::Add; | ||
|
||
#[derive(Debug)] | ||
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 } | ||
} | ||
} | ||
|
||
fn main() { | ||
let p1 = Point { x: 1, y: 0 }; | ||
let p2 = Point { x: 2, y: 3 }; | ||
|
||
let p3 = p1 + p2; | ||
|
||
println!("{:?}", p3); | ||
} | ||
``` | ||
|
||
In `main`, we can use `+` on our two `Point`s, since we’ve implemented | ||
`Add<Output=Point>` for `Point`. | ||
|
||
There are a number of operators that can be overloaded this way, and all of | ||
their associated traits live in the [`std::ops`][stdops] module. Check out its | ||
documentation for the full list. | ||
|
||
[stdops]: ../std/ops/index.html | ||
|
||
Implementing these traits follows a pattern. Let’s look at [`Add`][add] in more | ||
detail: | ||
|
||
```rust | ||
# mod foo { | ||
pub trait Add<RHS = Self> { | ||
type Output; | ||
|
||
fn add(self, rhs: RHS) -> Self::Output; | ||
} | ||
# } | ||
``` | ||
|
||
[add]: ../std/ops/trait.Add.html | ||
|
||
There’s three types in total involved here: the type you `impl Add` for, `RHS`, | ||
which defaults to `Self`, and `Output`. For an expression `let z = x + y`, `x` | ||
is the `Self` type, `y` is the RHS, and `z` is the `Self::Output` type. | ||
|
||
```rust | ||
# struct Point; | ||
# use std::ops::Add; | ||
impl Add<i32> for Point { | ||
type Output = f64; | ||
|
||
fn add(self, rhs: i32) -> f64 { | ||
// add an i32 to a Point and get an f64 | ||
# 1.0 | ||
} | ||
} | ||
``` | ||
|
||
will let you do this: | ||
|
||
```rust,ignore | ||
let p: Point = // ... | ||
let x: f64 = p + 2i32; | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the backticks got a little jumbled somewhere around here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
whoops!