#cast #ref #casting #field

ref-cast

Safely cast &T to &U where the struct U contains a single field of type T

16 releases (7 stable)

1.0.6 Dec 29, 2020
1.0.3 Oct 29, 2020
1.0.2 Jun 16, 2020
1.0.1 Mar 23, 2020
0.2.0 Oct 28, 2017
Download history 19533/week @ 2021-01-17 20833/week @ 2021-01-24 22166/week @ 2021-01-31 22578/week @ 2021-02-07 22252/week @ 2021-02-14 25367/week @ 2021-02-21 25171/week @ 2021-02-28 26660/week @ 2021-03-07 25862/week @ 2021-03-14 25135/week @ 2021-03-21 27457/week @ 2021-03-28 26085/week @ 2021-04-04 25562/week @ 2021-04-11 24388/week @ 2021-04-18 24800/week @ 2021-04-25 21030/week @ 2021-05-02

82,459 downloads per month
Used in 450 crates (18 directly)

MIT/Apache

15KB
112 lines

RefCast

github crates.io docs.rs build status

Safely cast &T to &U where the struct U contains a single field of type T.

[dependencies]
ref-cast = "1.0"

Basic example

use ref_cast::RefCast;

#[derive(RefCast)]
#[repr(transparent)]
struct U(String);

fn main() {
    let s = String::new();

    // Safely cast from `&String` to `&U`.
    let u = U::ref_cast(&s);
}

Note that either of #[repr(C)] or #[repr(transparent)] is required in order for the conversion to be sound. The derive macro will refuse to compile if neither is present.

Realistic example

Suppose we have a multidimensional array represented in a flat buffer in row-major order for performance reasons, but we want to expose an indexing operation that works in column-major order because it is more intuitive in the context of our application.

const MAP_WIDTH: usize = 4;

struct Tile(u8);

struct TileMap {
    storage: Vec<Tile>,
}

// `tilemap[x][y]` should give us `tilemap.storage[y * MAP_WIDTH + x]`.

The signature of the Index trait in Rust is such that the output is forced to be borrowed from the type being indexed. So something like the following is not going to work.

struct Column<'a> {
    tilemap: &'a TileMap,
    x: usize,
}

// Does not work! The output of Index must be a reference that is
// borrowed from self. Here the type Column is not a reference.
impl Index<usize> for TileMap {
    fn index(&self, x: usize) -> Column {
        assert!(x < MAP_WIDTH);
        Column { tilemap: self, x }
    }
}

impl<'a> Index<usize> for Column<'a> {
    fn index(&self, y: usize) -> &Tile {
        &self.tilemap.storage[y * MAP_WIDTH + self.x]
    }
}

Here is a working approach using RefCast.

#[derive(RefCast)]
#[repr(transparent)]
struct Strided([Tile]);

// Implement `tilemap[x][y]` as `tilemap[x..][y * MAP_WIDTH]`.
impl Index<usize> for TileMap {
    type Output = Strided;
    fn index(&self, x: usize) -> &Self::Output {
        assert!(x < MAP_WIDTH);
        Strided::ref_cast(&self.storage[x..])
    }
}

impl Index<usize> for Strided {
    type Output = Tile;
    fn index(&self, y: usize) -> &Self::Output {
        &self.0[y * MAP_WIDTH]
    }
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~345–770KB
~19K SLoC