Struct ProvenanceId

pub struct ProvenanceId(/* private fields */);

Available on crate feature provenance only.

A provenance ID

This is an integer referring to a row of a [provenance::ProvenanceTable].

The features for this type follow the same pattern as for NodeId

Implementations

impl ProvenanceId

pub const NULL: ProvenanceId

NULL value for this type.

pub fn is_null(&self) -> bool

Return true is self == Self::NULL

pub fn to_usize(&self) -> Option<usize>

Convenience function to convert to usize.

Works via TryFrom.

Returns

• None if the underlying value is negative.
• Some(usize) otherwise.

pub fn as_usize(&self) -> usize

Convenience function to convert to usize. Implemented via as. Negative values with therefore wrap.

Trait Implementations

impl Clone for ProvenanceId

fn clone(&self) -> ProvenanceId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProvenanceId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProvenanceId

fn default() -> Self

Returns the “default value” for a type.

impl Display for ProvenanceId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ProvenanceId> for tsk_id_t

fn from(value: ProvenanceId) -> Self

Converts to this type from the input type.

impl From<i32> for ProvenanceId

fn from(value: tsk_id_t) -> Self

Converts to this type from the input type.

impl Hash for ProvenanceId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProvenanceId

fn cmp(&self, other: &ProvenanceId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<ProvenanceId> for tsk_id_t

fn eq(&self, other: &ProvenanceId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for ProvenanceId

fn eq(&self, other: &tsk_id_t) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ProvenanceId

fn eq(&self, other: &ProvenanceId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ProvenanceId> for tsk_id_t

fn partial_cmp(&self, other: &ProvenanceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<i32> for ProvenanceId

fn partial_cmp(&self, other: &tsk_id_t) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for ProvenanceId

fn partial_cmp(&self, other: &ProvenanceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<ProvenanceId> for SizeType

type Error = TskitError

The type returned in the event of a conversion error.

fn try_from(value: ProvenanceId) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ProvenanceId> for usize

type Error = TskitError

The type returned in the event of a conversion error.

fn try_from(value: ProvenanceId) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ProvenanceId

impl Eq for ProvenanceId

impl StructuralPartialEq for ProvenanceId