Struct tskit::SiteId

source · [−]

#[repr(transparent)]
pub struct SiteId(_);

Expand description

A site ID

This is an integer referring to a row of an SiteTable.

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

Implementations

source

impl SiteId

source

pub const NULL: SiteId = Self(crate::TSK_NULL)

NULL value for this type.

source

pub fn is_null(&self) -> bool

Return true is self == Self::NULL

Trait Implementations

source

impl Clone for SiteId

source

fn clone(&self) -> SiteId

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for SiteId

source

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

Formats the value using the given formatter. Read more

source

impl Display for SiteId

source

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

Formats the value using the given formatter. Read more

source

impl From<SiteId> for usize

source

fn from(value: SiteId) -> Self

Converts to this type from the input type.

source

impl From<SiteId> for tsk_id_t

source

fn from(value: SiteId) -> Self

Converts to this type from the input type.

source

impl From<i32> for SiteId

source

fn from(value: tsk_id_t) -> Self

Converts to this type from the input type.

source

impl Hash for SiteId

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for SiteId

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<SiteId> for SiteId

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl PartialEq<SiteId> for tsk_id_t

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl PartialEq<SiteId> for SizeType

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl PartialEq<SizeType> for SiteId

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl PartialEq<i32> for SiteId

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl PartialOrd<SiteId> for SiteId

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl PartialOrd<SiteId> for tsk_id_t

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl PartialOrd<SiteId> for SizeType

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl PartialOrd<SizeType> for SiteId

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl PartialOrd<i32> for SiteId

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl TryFrom<SiteId> for SizeType

type Error = TskitError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl StructuralPartialEq for SiteId

Auto Trait Implementations

impl RefUnwindSafe for SiteId

impl Send for SiteId

impl Sync for SiteId

impl Unpin for SiteId

impl UnwindSafe for SiteId

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Free for T

source

unsafe default fn free(ptr_ref: NonNull<T>)

Drops the content pointed by this pointer and frees it. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tskit::SiteId

Implementations

impl SiteId

pub const NULL: SiteId = Self(crate::TSK_NULL)

pub fn is_null(&self) -> bool

Trait Implementations

impl Clone for SiteId

fn clone(&self) -> SiteId

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

impl Debug for SiteId

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

impl Display for SiteId

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

impl From<SiteId> for usize

fn from(value: SiteId) -> Self

impl From<SiteId> for tsk_id_t

fn from(value: SiteId) -> Self

impl From<i32> for SiteId

fn from(value: tsk_id_t) -> Self

impl Hash for SiteId

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

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

impl Ord for SiteId

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

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

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

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

impl PartialEq<SiteId> for SiteId

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

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

impl PartialEq<SiteId> for tsk_id_t

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

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

impl PartialEq<SiteId> for SizeType

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

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

impl PartialEq<SizeType> for SiteId

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

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

impl PartialEq<i32> for SiteId

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

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

impl PartialOrd<SiteId> for SiteId

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

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

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

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

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

impl PartialOrd<SiteId> for tsk_id_t

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

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

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

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

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

impl PartialOrd<SiteId> for SizeType

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

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

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

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

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

impl PartialOrd<SizeType> for SiteId

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

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

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

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

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

impl PartialOrd<i32> for SiteId

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

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

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

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

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

impl TryFrom<SiteId> for SizeType

type Error = TskitError

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

impl Copy for SiteId

impl Eq for SiteId

impl StructuralEq for SiteId

impl StructuralPartialEq for SiteId

Auto Trait Implementations

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,