Struct NodeDefaults

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

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

impl Clone for NodeDefaults

fn clone(&self) -> NodeDefaults

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeDefaults

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

Formats the value using the given formatter.

impl Default for NodeDefaults

fn default() -> NodeDefaults

Returns the “default value” for a type.

impl PartialEq for NodeDefaults

fn eq(&self, other: &NodeDefaults) -> 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 Copy for NodeDefaults

impl Eq for NodeDefaults

impl StructuralPartialEq for NodeDefaults