Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions src/_macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,25 @@ macro_rules! impl_id_traits {
pub fn is_null(&self) -> bool {
*self == Self::NULL
}

/// Convenience function to convert to usize.
///
/// Works via [`TryFrom`].
///
/// # Returns
///
/// * `None` if the underlying value is negative.
/// * `Some(usize)` otherwise.
pub fn to_usize(&self) -> Option<usize> {
usize::try_from(*self).ok()
}

/// Convenience function to convert to usize.
/// Implemented via `as`.
/// Negative values with therefore wrap.
pub fn as_usize(&self) -> usize {
self.0 as usize
}
}

impl std::fmt::Display for $idtype {
Expand Down
11 changes: 11 additions & 0 deletions tests/test_id_types.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#[test]
fn test_node_id_as_usize() {
let x = tskit::NodeId::from(0);
assert_eq!(x.to_usize(), Some(0_usize));
assert_eq!(x.as_usize(), 0_usize);
let x = tskit::NodeId::from(-1);
assert_eq!(x.to_usize(), None);
assert_eq!(x.as_usize(), usize::MAX);
let x = tskit::NodeId::from(-2);
assert_eq!(x.as_usize(), -2_i32 as usize);
}