% Traits

Un trait es una facilidad del lenguaje que le indica compilador de Rust acerca de la funcionalidad que un tipo debe proveer.

Recuerdas la palabra reservada impl?, usada para llamar a una función con la sintaxis de métodos?

struct Circulo {
    x: f64,
    y: f64,
    radio: f64,
}

impl Circulo {
    fn area(&self) -> f64 {
        std::f64::consts::PI * (self.radio * self.radio)
    }
}

Los traits son similares, excepto que definimos un trait con solo la firma de método y luego implementamos el trait para la estructura. Así:

struct Circulo {
    x: f64,
    y: f64,
    radio: f64,
}

trait TieneArea {
    fn area(&self) -> f64;
}

impl TieneArea for Circulo {
    fn area(&self) -> f64 {
        std::f64::consts::PI * (self.radio * self.radio)
    }
}

Como puedes ver, el bloque trait luce muy similar a el bloque impl, pero no definimos un bloque, solo la firma de tipos. Cuando implementamos un trait, usamos impl Trait for Item, en vez de solo impl Item.

Limites trait para funciones genéricas

Los traits son útiles porque permiten a un tipo hacer ciertas promesas acerca de su comportamiento. La funciones genéricas pueden explotar esto para restringir los tipos que aceptan. Considera esta función, la cual no compila:

fn imrimir_area(figura: T) {
    println!("Esta figura tiene un area de {}", figura.area());
}

Rust se queja:

error: no method named `area` found for type `T` in the current scope

Debido a que T puede ser de cualquier tipo, no podemos estar seguros que implementa el método area. Pero podemos agregar una ‘restricción de trait’ a nuestro T genérico, asegurándonos de que lo implemente:

# trait TieneArea {
#     fn area(&self) -> f64;
# }
fn imrimir_area<T: TieneArea>(shape: T) {
    println!("Esta figura tiene un area de {}", figura.area());
}

La sintaxis <T: TieneArea> se traduce en “cualquier tipo que implemente el trait TieneArea.”. A consecuencia de que los traits definen firmas de tipos de función, podemos estar seguros que cualquier tipo que implemente TieneArea tendrá un método .area().

He aquí un ejemplo extendido de como esto funciona:

trait TieneArea {
    fn area(&self) -> f64;
}

struct Circulo {
    x: f64,
    y: f64,
    radio: f64,
}

impl TieneArea for Circulo {
    fn area(&self) -> f64 {
        std::f64::consts::PI * (self.radio * self.radio)
    }
}

struct Cuadrado {
    x: f64,
    y: f64,
    lado: f64,
}

impl TieneArea for Cuadrado {
    fn area(&self) -> f64 {
        self.lado * self.lado
    }
}

fn imrimir_area<T: TieneArea>(figura: T) {
    println!("Esta figura tiene un area de {}", figura.area());
}

fn main() {
    let c = Circulo {
        x: 0.0f64,
        y: 0.0f64,
        radio: 1.0f64,
    };

    let s = Cuadrado {
        x: 0.0f64,
        y: 0.0f64,
        lado: 1.0f64,
    };

    imrimir_area(c);
    imrimir_area(s);
}

Este programa produce la salida:

Esta figura tiene un area de 3.141593
Esta figura tiene un area de 1

Como puedes ver, imrimir_area ahora es genérica, pero también asegura que hallamos proporcionado los tipos correctos. Si pasamos un tipo incorrecto:

imrimir_area(5);

Obtenemos un error en tiempo de compilación:

error: the trait `TieneArea` is not implemented for the type `_` [E0277]

Limites de trait para estructuras genericas

Tus estructuras genéricas pueden beneficiarse también de las restricciones de trait. Todo lo que necesitas es agregar la restricción cuando declaras los parámetros de tipos. A continuación un nuevo tipo Rectangulo<T> y su operación es_cuadrado:

struct Rectangulo<T> {
    x: T,
    y: T,
    ancho: T,
    altura: T,
}

impl<T: PartialEq> Rectangulo<T> {
    fn es_cuadrado(&self) -> bool {
        self.ancho == self.altura
    }
}

fn main() {
    let mut r = Rectangulo {
        x: 0,
        y: 0,
        ancho: 47,
        altura: 47,
    };

    assert!(r.es_cuadrado());

    r.altura = 42;
    assert!(!r.es_cuadrado());
}

es_cuadrado() necesita chequear que los lados son iguales, y para ello los tipos deben ser de un tipo que implemente el trait core::cmp::PartialEq:

impl Rectangulo { ... }

Ahora, un rectángulo puede ser definido en función de cualquier tipo que pueda ser comparado por igualdad.

Hemos definido una nueva estructura Rectangulo que acepta números de cualquier precision, objetos de cualquier tipo siempre y cuando puedan ser comparados por igualdad. Podríamos hacer lo mismo para nuestras estructuras TieneArea, Cuadrado y Circulo? Si, pero estas necesitan multiplicación, y para trabajar con eso necesitamos saber mas de los traits de operadores.

Reglas para la implementación de traits

Hasta ahora, solo hemos agregado implementaciones de traits a estructuras, pero puedes implementar cualquier trait para cualquier tipo. Técnicamente, podriamos implementar TieneArea para i32:

trait TieneArea {
    fn area(&self) -> f64;
}

impl TieneArea for i32 {
    fn area(&self) -> f64 {
        println!("esto es tonto");

        *self as f64
    }
}

5.area();

Se considera pobre estilo implementar métodos en esos tipos primitivos, aun cuando es posible.

Esto puede lucir como el viejo oeste, pero hay dos restricciones acerca de la implementación de traits que previenen que las cosas se salgan de control. La primera es que si el trait no esta definido en tu ámbito, no aplica. He aquí un ejemplo: la biblioteca estándar provee un trait Write que agrega funcionalidad extra a los Files, posibilitando la E/S de archivos. Por defecto, un File no tendría sus métodos:

let mut f = std::fs::File::open("foo.txt").ok().expect("No se pudo abrir foo.txt");
let buf = b"cualquier cosa"; // literal de cadena de bytes. buf: &[u8; 8]
let resultado = f.write(buf);
# resultado.unwrap(); // ignorar el error

He aqui el error:

error: type `std::fs::File` does not implement any method in scope named `write`
let resultado = f.write(buf);
               ^~~~~~~~~~

Necesitamos primero hacer use del trait Write:

use std::io::Write;

let mut f = std::fs::File::open("foo.txt").ok().expect("No se pudo abrir foo.txt");
let buf = b"cualquier cosa";
let resultado = f.write(buf);
# resultado.unwrap(); // ignorar el error

Lo anterior compilara sin errores.

Esto significa que incluso si alguien hace algo malo como agregar métodos a i32, no te afectara, a menos que hagas use de ese trait.

Hay una restricción mas acerca de la implementación de traits: uno de los dos bien sea el trait o el tipo para el cual estas escribiendo la impl, debe ser definido por ti. Entonces, podríamos implementar el trait TieneArea para el tipo i32, puesto que TieneArea esta en nuestro código. Pero si intentáramos implementar ToString, un trait proporcionado por Rust para i32, no podríamos, debido a que ni el trait o el tipo están en nuestro código.

Una ultima cosa acerca de los traits: las funciones genéricas con un limite de trait usan ‘monomorfizacion’ (‘monomorphization’) (mono: uno, morfos: forma), y por ello son despachadas estáticamente. Que significa esto? Echa un vistazo a el capitulo acerca de objetos trait para mas detalles.

Multiples limites de trait

Has visto que puedes limitar un parámetro de tipo genérico con un trait:

fn foo<T: Clone>(x: T) {
    x.clone();
}

Si necesitas mas de un limite, puedes hacer uso de +:

use std::fmt::Debug;

fn foo<T: Clone + Debug>(x: T) {
    x.clone();
    println!("{:?}", x);
}

T necesita ahora ser ambos Clone y Debug.

La clausula where

Escribir funciones con solo unos pocos tipos genéricos y un pequeño numero de limites de trait no es tan feo, pero a medida que el numero se incrementa, la sintaxis se vuelve un poco extraña:

use std::fmt::Debug;

fn foo<T: Clone, K: Clone + Debug>(x: T, y: K) {
    x.clone();
    y.clone();
    println!("{:?}", y);
}

El nombre de la función esta lejos a la izquierda, y la lista de parámetros esta lejos a la derecha. Los limites de trait se interponen en la mitad.

Rust tiene una solución, y se llama ‘clausula where’:

use std::fmt::Debug;

fn foo<T: Clone, K: Clone + Debug>(x: T, y: K) {
    x.clone();
    y.clone();
    println!("{:?}", y);
}

fn bar<T, K>(x: T, y: K) where T: Clone, K: Clone + Debug {
    x.clone();
    y.clone();
    println!("{:?}", y);
}

fn main() {
    foo("Hola", "mundo");
    bar("Hola", "mundo");
}

foo() usa la sintaxis demostrada previamente, y bar() usa una clausula where. Todo lo que necesitas es dejar los limites por fuera cuando definas tus parámetros de tipo y luego agregar un where después de la lista de parámetros. Para listas mas largas, espacios en blanco pueden ser agregados:

use std::fmt::Debug;

fn bar<T, K>(x: T, y: K)
    where T: Clone,
          K: Clone + Debug {

    x.clone();
    y.clone();
    println!("{:?}", y);
}

Dicha flexibilidad puede agregar claridad en situaciones complejas.

La clausula where es también mas poderosa que la sintaxis mas simple. Por ejemplo:

trait ConvertirA<Salida> {
    fn convertir(&self) -> Salida;
}

impl ConvertirA<i64> for i32 {
    fn convertir(&self) -> i64 { *self as i64 }
}

// puede ser llamada con T == i32
fn normal<T: ConvertirA<i64>>(x: &T) -> i64 {
    x.convertir()
}

// puede ser llamada con T == i64
fn inversa<T>() -> T
        // pesto es user ConvertirA como si fuera "ConvertirA<i64>"
        where i32: ConvertirA<T> {
    42.convertir()
}

Lo anterior demuestra una característica adicional de where: permite limites en los que el lado izquierdo es un tipo arbitrario (i32 en este caso), no solo un simple parámetro de tipo (como T).

Metodos por defecto

Si ya sabes como un implementador típico definirá un método, puedes permitir a tu trait proporcionar uno método por defecto:

trait Foo {
    fn es_valido(&self) -> bool;

    fn es_invalido(&self) -> bool { !self.es_valido() }
}

Los implementadores del trait Foo necesitan implementar es_valido(), pero no necesitan implementar es_invalido(). Lo obtendrán por defecto. También pueden sobreescribir la implementación por defecto si lo desean:

# trait Foo {
#     fn es_valido(&self) -> bool;
#
#     fn es_invalido(&self) -> bool { !self.es_valido() }
# }
struct UsaDefault;

impl Foo for UsaDefault {
    fn es_valido(&self) -> bool {
        println!("UsaDefault.es_valid llamada.");
        true
    }
}

struct SobreescribeDefault;

impl Foo for SobreescribeDefault {
    fn es_valido(&self) -> bool {
        println!("SobreescribeDefault.es_valido llamada.");
        true
    }

    fn es_invalido(&self) -> bool {
        println!("SobreescribeDefault.es_invalido llamada!");
        true // esta implementacion es una auto-contradiccion!
    }
}

let default = UsaDefault;
assert!(!default.es_valido()); // imprime "UsaDefault.es_valid llamada."

let sobre = SobreescribeDefault;
assert!(sobre.is_invalid()); // prints "SobreescribeDefault.es_invalido llamada!"

Herencia

Algunas veces, implementar un trait requiere implementar otro:

trait Foo {
    fn foo(&self);
}

trait FooBar : Foo {
    fn foobar(&self);
}

Los implementadores de FooBar deben también implementar Foo, de esta manera:

# trait Foo {
#     fn foo(&self);
# }
# trait FooBar : Foo {
#     fn foobar(&self);
# }
struct Baz;

impl Foo for Baz {
    fn foo(&self) { println!("foo"); }
}

impl FooBar for Baz {
    fn foobar(&self) { println!("foobar"); }
}

Si olvidamos implementar Foo, Rust nos lo dira:

error: the trait `main::Foo` is not implemented for the type `main::Baz` [E0277]