Skip to main content

NodeDefaults

Struct NodeDefaults 

Source
pub struct NodeDefaults {
    pub flags: NodeFlags,
    pub population: PopulationId,
    pub individual: IndividualId,
}
Expand description

Defaults for node table rows without metadata

§Examples

let d = tskit::NodeDefaults::default();
assert_eq!(d.flags, tskit::NodeFlags::default());
assert_eq!(d.population, tskit::PopulationId::NULL);
assert_eq!(d.individual, tskit::IndividualId::NULL);

Struct update syntax is your friend here:

let d = tskit::NodeDefaults{population: 0.into(), ..Default::default()};
assert_eq!(d.flags, tskit::NodeFlags::default());
assert_eq!(d.population, 0);
assert_eq!(d.individual, tskit::IndividualId::NULL);
let d2 = tskit::NodeDefaults{flags: tskit::NodeFlags::default().mark_sample(),
                            // update remaining values from d
                            ..d};
assert!(d2.flags.is_sample());
assert_eq!(d2.population, 0);
assert_eq!(d2.individual, tskit::IndividualId::NULL);

Fields§

§flags: NodeFlags§population: PopulationId§individual: IndividualId

Trait Implementations§

Source§

impl Clone for NodeDefaults

Source§

fn clone(&self) -> NodeDefaults

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NodeDefaults

Source§

impl Debug for NodeDefaults

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for NodeDefaults

Source§

fn default() -> NodeDefaults

Returns the “default value” for a type. Read more
Source§

impl Eq for NodeDefaults

Source§

impl PartialEq for NodeDefaults

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NodeDefaults

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.