Files
oak-editor/crates/oak-node/src/id.rs
T
Mike-Solar 244d5e860f
CI / Build & test (Windows) (push) Failing after 7s
workspace: kebab-case crates, app under crates/oak-app, shared versions
All crates take the oak-* kebab-case naming (oak-audio, oak-codec,
oak-common, oak-core, oak-ffmpeg-link, oak-node, oak-otio, oak-plugin,
oak-render, oak-storage, oak-task, oak-timeline, oak-undo), with the
lib identifiers rewritten (oakrender:: -> oak_render::, oakcore_rs:: ->
oak_core::, ...) across all 226 referencing files.

The GUI application moves from the workspace root into
crates/oak-app/: src/, build.rs (paths fixed for the new location) and
tests/ travel with it, the root Cargo.toml becomes workspace-only
([workspace] + workspace.package + profiles), and the app package
inherits the workspace version. The screenshots example becomes a
standalone crate examples/simple_player/ with its own Cargo.toml.

Every crate now inherits the single workspace version
(version.workspace = true), and the workflows' crate paths and the
build docs follow the renames.

Validated with a clean cargo check --workspace.
2026-08-22 16:58:37 +08:00

79 lines
2.6 KiB
Rust

// Oak Video Editor - Non-Linear Video Editor
// Copyright (C) 2026 Oak Team
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! Generational identifiers for arena-stored graph objects.
//!
//! The public C ABI hands out opaque refcounted handle boxes; inside
//! the crate, a handle boxes `(Arc<Mutex<Project>>, NodeId)`. The
//! generation counter makes a stale `NodeId` (whose slot was reused)
//! fail loudly instead of aliasing a different node — this replaces
//! the C++ design's dangling-pointer failure mode with a checked one.
/// Id of a node inside a [`crate::graph::Graph`] arena.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NodeId {
index: u32,
generation: u32,
}
impl NodeId {
/// Sentinel marking "no node" (project without a root folder, empty
/// references). Not a valid arena slot: the arena never produces this
/// value (an index of `u32::MAX` is rejected by [`NodeId::valid`]).
pub const INVALID: NodeId = NodeId {
index: u32::MAX,
generation: 0,
};
/// Construct from raw parts (arena-internal use).
pub(crate) fn new(index: u32, generation: u32) -> NodeId {
NodeId { index, generation }
}
/// True when this id names a real arena slot (not [`NodeId::INVALID`]).
pub fn valid(self) -> bool {
self.index != u32::MAX
}
/// Slot index.
pub fn index(self) -> u32 {
self.index
}
/// Generation counter.
pub fn generation(self) -> u32 {
self.generation
}
/// Stable identity integer for registry keys and XML cross-
/// references (replaces the C++ raw-pointer `uintptr_t` identity;
/// NOT an address, safe to persist within a session).
pub fn identity(self) -> u64 {
((self.generation as u64) << 32) | self.index as u64
}
/// Inverse of [`NodeId::identity`]: rebuild an id from its packed
/// form. `None` for the invalid sentinel.
pub fn from_identity(id: u64) -> Option<NodeId> {
let index = (id & 0xffff_ffff) as u32;
let generation = (id >> 32) as u32;
if index == u32::MAX {
return None;
}
Some(NodeId { index, generation })
}
}