Publish?

[Nickersoft]

Is this package currently published? Can't find it on the crate registry and am just using it via GitHub URL right now.

[djkoloski]

It's not published, I just never got around to it. Before publishing, it should probably have some proper documentation and a README.

[Nickersoft]

Got it – but in general it's safe to use? Could you give me a quick example of how to use it, as I'm looking to intern strings in my project

[djkoloski]

Yeah it's safe to use. Check out the tests in lib.rs for examples, here's one I pulled out:

use rkyv::{
    access,
    api::serialize_using,
    deserialize,
    rancor::Failure,
    ser::{sharing::Share, Serializer},
    util::{with_arena, AlignedVec},
    Archive, Archived, Deserialize, Serialize,
};
use rkyv_intern::{Intern, Interner, InterningAdapter};

#[derive(Archive, Serialize, Deserialize, PartialEq, Debug)]
struct Log {
    #[rkyv(with = Intern)]
    user: String,
    code: u16,
}

fn main() {
    const USERS: [&str; 4] = [
        "Alice, the leader and brains behind the team",
        "Bob, bodybuilder and the muscle of the operation",
        "Carol, safe-cracker and swindler extraordinaire",
        "Dave, Jumanji master of the spirit dimension",
    ];

    let mut value = Vec::new();
    for i in 0..1000 {
        value.push(Log {
            user: USERS[i % USERS.len()].to_string(),
            code: (i % u16::MAX as usize) as u16,
        });
    }

    let bytes = with_arena(|arena| {
        let mut serializer = InterningAdapter::new(
            Serializer::new(AlignedVec::<16>::new(), arena.acquire(), Share::new()),
            Interner::new(),
        );
        serialize_using::<_, Failure>(&value, &mut serializer).unwrap();
        serializer.into_serializer().into_writer()
    });
    assert!(bytes.len() < 20_000);

    let archived = access::<Archived<Vec<Log>>, Failure>(&bytes).unwrap();
    for (a, b) in archived.iter().zip(value.iter()) {
        assert_eq!(*a.user, b.user);
        assert_eq!(a.code, b.code);
    }

    let deserialized = deserialize::<Vec<Log>, Failure>(archived).unwrap();
    assert_eq!(deserialized, value);
}