snippetrustCritical
How do I implement the Add trait for a reference to a struct?
Viewed 0 times
howstructreferencetheforaddimplementtrait
Problem
I made a two element
I made all my functions and methods take references, rather than values, and I want the
Depending on which variation I try, I either get lifetime problems or type mismatches. Specifically, the
I have seen examples with template arguments on
I found How can an operator be overloaded for different RHS types and return values? but the code in the answer doesn't work even if I put a
I am using rustc 1.0.0-nightly (ed530d7a3 2015-01-16 22:41:16 +0000)
I won't accept "you only have two fields, why use a reference" as an answer; what if I wanted a 100 element struct? I will accept an answer that demonstrates that even with a large struct I should be passing by value, if that is the case (I don't think it is, though.) I am interested in knowing a good rule of thumb for struct size and passing by value vs struct, but that is not the current question.
Vector struct and I want to overload the + operator.I made all my functions and methods take references, rather than values, and I want the
+ operator to work the same way.impl Add for Vector {
fn add(&self, other: &Vector) -> Vector {
Vector {
x: self.x + other.x,
y: self.y + other.y,
}
}
}Depending on which variation I try, I either get lifetime problems or type mismatches. Specifically, the
&self argument seems to not get treated as the right type.I have seen examples with template arguments on
impl as well as Add, but they just result in different errors.I found How can an operator be overloaded for different RHS types and return values? but the code in the answer doesn't work even if I put a
use std::ops::Mul; at the top.I am using rustc 1.0.0-nightly (ed530d7a3 2015-01-16 22:41:16 +0000)
I won't accept "you only have two fields, why use a reference" as an answer; what if I wanted a 100 element struct? I will accept an answer that demonstrates that even with a large struct I should be passing by value, if that is the case (I don't think it is, though.) I am interested in knowing a good rule of thumb for struct size and passing by value vs struct, but that is not the current question.
Solution
You need to implement
In its definition,
Here,
Note that I also specified the
1 Actually, reference types are special in that you can implement traits for references to types defined in your crate (i.e. if you're allowed to implement a trait for
Add on &Vector rather than on Vector.impl Add for &'a Vector {
type Output = Vector;
fn add(self, other: &'b Vector) -> Vector {
Vector {
x: self.x + other.x,
y: self.y + other.y,
}
}
}In its definition,
Add::add always takes self by value. But references are types like any other1, so they can implement traits too. When a trait is implemented on a reference type, the type of self is a reference; the reference is passed by value. Normally, passing by value in Rust implies transferring ownership, but when references are passed by value, they're simply copied (or reborrowed/moved if it's a mutable reference), and that doesn't transfer ownership of the referent (because a reference doesn't own its referent in the first place). Considering all this, it makes sense for Add::add (and many other operators) to take self by value: if you need to take ownership of the operands, you can implement Add on structs/enums directly, and if you don't, you can implement Add on references.Here,
self is of type &'a Vector, because that's the type we're implementing Add on.Note that I also specified the
RHS type parameter with a different lifetime to emphasize the fact that the lifetimes of the two input parameters are unrelated.1 Actually, reference types are special in that you can implement traits for references to types defined in your crate (i.e. if you're allowed to implement a trait for
T, then you're also allowed to implement it for &T). &mut T and Box have the same behavior, but that's not true in general for U where U is not defined in the same crate.Code Snippets
impl<'a, 'b> Add<&'b Vector> for &'a Vector {
type Output = Vector;
fn add(self, other: &'b Vector) -> Vector {
Vector {
x: self.x + other.x,
y: self.y + other.y,
}
}
}Context
Stack Overflow Q#28005134, score: 118
Revisions (0)
No revisions yet.