Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt at changing ItemId struct into a trait, and passing ItemIdT type parameter around. #181

Merged
merged 7 commits into from
Feb 1, 2024
Merged

Attempt at changing ItemId struct into a trait, and passing ItemIdT type parameter around. #181

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bc2bb6b
Change `ItemId` struct into a trait.
azriel91 Jan 31, 2024
8c94293
Text replace `ItemId` with `ItemidT`.
azriel91 Jan 31, 2024
cd338c2
A lot of string replacements to add `<ItemIdT>`.
azriel91 Feb 1, 2024
34227b6
Revert "A lot of string replacements to add `<ItemIdT>`."
azriel91 Feb 1, 2024
6269e39
Revert "Text replace `ItemId` with `ItemidT`."
azriel91 Feb 1, 2024
9255e0c
Revert "Change `ItemId` struct into a trait."
azriel91 Feb 1, 2024
8edea31
Add design note about upgrades for `ItemId`s.
azriel91 Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions crate/core/src/item_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ use serde::{Deserialize, Serialize};
/// let _camel = item_id!("camelCase");
/// let _pascal = item_id!("PascalCase");
/// ```
///
/// # Design Note
///
/// TODO: Experiment with upgrades.
///
/// For backward compatibility and migrating items from old IDs to new IDs, e.g.
/// when they were deployed with an old version of the automation software,
/// there needs to be a way to:
///
/// * Read state using the old ID.
/// * Either clean up that state, or migrate that state into an Item with the
/// new ID.
#[derive(Clone, Debug, Hash, PartialEq, Eq, Deserialize, Serialize)]
pub struct ItemId(Cow<'static, str>);

Expand Down
Loading