#vec #strongly-typed #derive-debug #indices #mixing #object #usize

keyed_vec

Vector type where the key is a custom object to avoid mixing indices between vectors

1 unstable release

0.1.0 Aug 15, 2023

#5 in #mixing

23 downloads per month
Used in index_graph

GPL-3.0-only

18KB
335 lines

A Vector type where the key is a custom object to avoid mixing indices between vectors.

Example

use keyed_vec::{KeyedVec, IndexLike};

#[derive(Debug, Clone)]
struct Client {
    name: String,
}

#[derive(Debug, Clone)]
struct Order {
    address: String
}

#[derive(Debug, Clone, Copy)]
struct ClientId(usize);
impl IndexLike for ClientId {
    fn to_index(&self) -> usize {
        self.0
    }

    fn from_index(i: usize) -> Self {
        ClientId(i)
    }
}

#[derive(Debug, Clone, Copy)]
struct OrderId(usize);
impl IndexLike for OrderId {
    fn to_index(&self) -> usize {
        self.0
    }

    fn from_index(i: usize) -> Self {
        OrderId(i)
    }
}

let mut clients = KeyedVec::<ClientId, Client>::new();
let client_a = clients.push(Client { name: "A".to_string() });

let mut orders = KeyedVec::<OrderId, Order>::new();
let order_1 = orders.push(Order { address: "1".to_string() });

// mismatched types expected `ClientId`, found `OrderId`
clients.get(order_1);

Dependencies

~1.5MB
~33K SLoC