Codestin Search App

optozorax · 2021-03-27T02:19:41Z

read CONTRIBUTING.md

egui/src/memory.rs

optozorax · 2021-03-27T14:42:35Z

Tomorrow I will write more documentation and rewrite all widgets to new API.

egui/src/memory.rs

optozorax · 2021-03-28T05:10:49Z

I will test this on the web, improve grammar and vocabulary in the documentation and mark this PR as ready for review.

emilk

Excellent work!

I left some comments, but beside that I think it would also be good with a couple of unit tests, especially covering serialization/deserialization of AnyMapId. For instance, does the AnyMapId handle serializing struct State { foo: i32 } and deserializing to stuct State { foo: i32, #[serde(default)] bar: f64 } (simulating adding a new field to an existing state)?

I also think you can make your own crate out of all this if you would like! I think it could become a popular alternative to e.g. anymap and std::any::Any for others who needs serialization!

egui/src/any/mod.rs

egui/src/any/any_map.rs

egui/src/any/serializable/any_map.rs

egui/src/any/serializable/element.rs

egui/src/any/element.rs

optozorax · 2021-03-28T15:09:11Z

Okay, thank you! Right now I am realized that I have no more time, so I can continue this PR after 6 April.

Also, thanks about the idea of moving this out as a crate 🤔

* rename `DataElement` -> `AnyMapElement` * make `data` in `Memory` as public field of type with public interface * make interface more rich * transform most unwraps to proper error handling * make `AnyMap` store by `TypeId`, so now individual type can be counted and reset

* replace `serde_json` -> `ron` * move `any_map` to module * separate `AnyMap` into `AnyMapId` and `serializable::AnyMapId` in order to not require `serde` traits in methods * add `AnyMap` and `serializable::AnyMap` that stores elements just by type, without `Id` * write documentation * change tooltips and color picker to use `Memory::data_temp`

Co-authored-by: Emil Ernerfeldt <[email protected]>

* rename `reset` → `remove` * add function `remove_by_type` * format code

optozorax · 2021-04-09T16:04:00Z

@emilk everything is done.

optozorax · 2021-04-09T16:30:09Z

I don't like all this copy-pasting in any_map and type_map files. So, I think it's possible to remove this copy-pasting by using type syntax and generics. I should try this.

optozorax · 2021-04-10T06:18:52Z

No, I believe this is not possible, because this may require an associated trait inside of a trait to generically handle AnyMapElement and serializable::AnyMapElement.

* make identical interface for serialized and simple maps * make serialized maps serialized fully, without features by moving this into `Memory` struct with `#[cfg(feature = "persistence")]` under fields * move `serialized::TypeId` into `AnyMapElement` struct

optozorax · 2021-04-10T19:02:20Z

However, copy-pasting between TypeMap/serializable::TypeMap and between AnyMap/serializable::AnyMap can be eliminated by using incude!() macro, but this is kinda ugly. I could do this, if you find this more proper than copy-pasting.

emilk

Amazing work - thank you! ⭐

emilk · 2021-04-12T19:42:53Z

egui/Cargo.toml

 multi_threaded = ["epaint/multi_threaded"]
+
+[dev-dependencies]
+serde_json = "1"


we could use ron for the tests too

emilk · 2021-04-12T19:48:12Z

egui/src/any/serializable/type_map.rs

+    };
+
+    let mut map: TypeMap = serde_json::from_str(&file_string).unwrap();
+    assert!(map.get::<StateNew>().is_none());


Oh right, because TypeId changes. In the future it would be nice to not rely on TypeId, but perhaps use a per-type UUID or similar to handle it. That would make persistence work across rustc versions too.

emilk · 2021-04-12T19:53:16Z

egui/src/any/any_map.rs

+
+/// Stores any object by `Key`.
+#[derive(Clone, Debug)]
+pub struct AnyMap<Key: Hash + Eq>(HashMap<Key, AnyMapElement>);


Now that this no longer relies on Id it would be trivial to move to its own crate - hint, hint, nudge, nudge ;)

@optozorax

This refactors the widget state storage introduced by @optozorax in #257 * Unify the four buckets (`data`, `data_temp`, `id_data` and `id_data_temp`) into a single `data`. * Less complexity, and also less chance of error (storing in one bucket, reading from another). * Store data by `Id` and `TypeId`. * Users can thus reuse the same `Id` to store many types. * Uses a simple xor of id and typeid, which is fast and good since both id and typeid are already high-entropy hashes. * Use different suffixes on the functions to pick if you want the data persisted or not (`get_temp`, `insert_persisted`, etc). * Writing with one suffix and reading with the other works. * To store state not bound to a specific `Id` (i.e. only based on type), use the new `Id::null` as the key.

@optozorax

This refactors the widget state storage introduced by @optozorax in emilk/egui#257 * Unify the four buckets (`data`, `data_temp`, `id_data` and `id_data_temp`) into a single `data`. * Less complexity, and also less chance of error (storing in one bucket, reading from another). * Store data by `Id` and `TypeId`. * Users can thus reuse the same `Id` to store many types. * Uses a simple xor of id and typeid, which is fast and good since both id and typeid are already high-entropy hashes. * Use different suffixes on the functions to pick if you want the data persisted or not (`get_temp`, `insert_persisted`, etc). * Writing with one suffix and reading with the other works. * To store state not bound to a specific `Id` (i.e. only based on type), use the new `Id::null` as the key.

@optozorax

This refactors the widget state storage introduced by @optozorax in emilk/egui#257 * Unify the four buckets (`data`, `data_temp`, `id_data` and `id_data_temp`) into a single `data`. * Less complexity, and also less chance of error (storing in one bucket, reading from another). * Store data by `Id` and `TypeId`. * Users can thus reuse the same `Id` to store many types. * Uses a simple xor of id and typeid, which is fast and good since both id and typeid are already high-entropy hashes. * Use different suffixes on the functions to pick if you want the data persisted or not (`get_temp`, `insert_persisted`, etc). * Writing with one suffix and reading with the other works. * To store state not bound to a specific `Id` (i.e. only based on type), use the new `Id::null` as the key.

optozorax mentioned this pull request Mar 27, 2021

Let Memory store arbitrary data for custom widgets. #255

Closed

optozorax changed the title ~~Arbitrary data in memory using Any~~ Arbitrary data in Memory using Any Mar 27, 2021

emilk reviewed Mar 27, 2021

View reviewed changes

egui/src/memory.rs Outdated Show resolved Hide resolved

emilk reviewed Mar 27, 2021

View reviewed changes

egui/src/memory.rs Outdated Show resolved Hide resolved

optozorax commented Mar 28, 2021

View reviewed changes

egui/src/memory.rs Outdated Show resolved Hide resolved

egui/src/memory.rs Show resolved Hide resolved

optozorax changed the title ~~Arbitrary data in Memory using Any~~ Arbitrary data in Memory using Any, fix #255 Mar 28, 2021

optozorax marked this pull request as ready for review March 28, 2021 06:00

emilk requested changes Mar 28, 2021

View reviewed changes

optozorax and others added 15 commits April 9, 2021 22:36

init work

e8b9e3c

implement deferred deserialization

e159078

improve storing TypeId between different rust versions

078ce55

rewrite system widgets to use AnyMap

99dd7c7

fix bugs and docs

a6dfc2d

Apply suggestions from code review

16a1a04

Co-authored-by: Emil Ernerfeldt <[email protected]>

rename AnyMap → TypeMap

bd5d041

rename AnyMapId → AnyMap, add generic <Key> to it

ec8da3a

rename files id_map → any_map

668508c

move out usages from serializable mod

177557d

rename ToDeserialize → Serialized

511a37a

fix bug with counting

5ee53f3

add tests, and...

aa8c081

* rename `reset` → `remove` * add function `remove_by_type` * format code

optozorax force-pushed the memory-arbitrary-data branch from 7a5eecb to aa8c081 Compare April 9, 2021 15:52

optozorax added 3 commits April 10, 2021 18:24

improve code

40f56f6

* make identical interface for serialized and simple maps * make serialized maps serialized fully, without features by moving this into `Memory` struct with `#[cfg(feature = "persistence")]` under fields * move `serialized::TypeId` into `AnyMapElement` struct

fix pipeline and add one more test

a65fe8c

update docs

ea685bb

emilk approved these changes Apr 12, 2021

View reviewed changes

emilk reviewed Apr 12, 2021

View reviewed changes

emilk merged commit 186362a into emilk:master Apr 12, 2021

optozorax deleted the memory-arbitrary-data branch April 13, 2021 01:51

emilk mentioned this pull request Oct 24, 2021

Refactor memory data #836

Merged

Conversation

optozorax commented Mar 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

optozorax commented Mar 27, 2021

Uh oh!

Uh oh!

Uh oh!

optozorax commented Mar 28, 2021

Uh oh!

emilk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

optozorax commented Mar 28, 2021

Uh oh!

optozorax commented Apr 9, 2021

Uh oh!

optozorax commented Apr 9, 2021

Uh oh!

optozorax commented Apr 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

optozorax commented Apr 10, 2021

Uh oh!

emilk left a comment

Choose a reason for hiding this comment

Uh oh!

emilk Apr 12, 2021

Choose a reason for hiding this comment

Uh oh!

emilk Apr 12, 2021

Choose a reason for hiding this comment

Uh oh!

emilk Apr 12, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

optozorax commented Mar 27, 2021 •

edited

Loading

optozorax commented Apr 10, 2021 •

edited

Loading