kabergstrom / prefab Goto Github PK

Now that the upstream changes in legion have landed in a released version of legion, I think we can look to publish this crate.

• Ensure all dependencies are up to date
• Asset-uuid and atelier-core are used as dev-dependencies. Not sure if cargo will allow publishing in this state?
• Merge #3 (possibly with edits :) )
• Review naming. For example, I was thinking about renaming Prefab to UncookedPrefab (we also have a CookedPrefab
• I've considered merging legion-prefab and legion-transaction. Now I'm looking at it, is seems like legion-prefab is doing RON serialization and transaction is doing bincode serialization. I suppose it's because prefabs generally get saved to disk and transactions are temporary in-memory. Regardless, I think the only justification for keeping the crates separate is that legion-transaction adds a dependency on bincode. I don't think there is much value in keeping them separate.
• Commenting pass - both API and some basic explanation of what's going on inside functions.
• cargo metadata (categories/keywords/description/authorship for crates.io)
• examples?
• unit tests?
• readme updates, any sort of announcement we want to do

I feel that much of the above could easily be pushed off to 0.2. Additionally we should keep an eye on bincode to release 1.3.0. We are somewhat blocked from publishing until bincode-org/bincode#321 is resolved.

The following file will not deserialize:

Prefab(
    id: "12b37b66-94f7-4fa6-abb3-4050619c3e11",
    objects: []
)

PrefabFormatDeserializer::prefab is None until PrefabFormatDeserializer::get_or_insert_prefab_mut is called, usually by ::begin_entity_object

If this does not occur prefab remains none and PrefabFormatDeserializer::prefab panics with the message "no valid prefab - make sure to deserialize before calling prefab()"

Could this perhaps more plug&play? Right now its a lot of code to get it working. Most of which makes absolutely no sense to me