Struct umgap::taxon::Taxon

pub struct Taxon {
    pub id: TaxonId,
    pub name: String,
    pub rank: Rank,
    pub parent: TaxonId,
    pub valid: bool,
}

Represents a group of organisms with similar qualities.

Fields

id: TaxonId

The taxon’s unique id

name: String

The taxon’s name

rank: Rank

The rank of the taxon

parent: TaxonId

The taxon’s parent

valid: bool

Whether the taxon is valid. false taxons are discarded in some calculations

Implementations

impl Taxon

pub fn new( id: TaxonId, name: String, rank: Rank, parent: TaxonId, valid: bool ) -> Taxon

Creates a taxon from the given arguments.

pub fn from_static( id: TaxonId, name: &str, rank: Rank, parent: TaxonId, valid: bool ) -> Taxon

Creates a taxon from the given arguments (using a &str instead of a String).

Trait Implementations

impl Clone for Taxon

fn clone(&self) -> Taxon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Taxon

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

Formats the value using the given formatter.

impl FromStr for Taxon

fn from_str(s: &str) -> Result<Self>

Parses a taxon from the given string.

Fields

A line is defined by 5 columns, separated with a tab. Note that all fields are required, in the following order: id,name,rank,parent,valid.

The valid-field will be parsed as true for "\x01" and false for "\x00".

Examples

use umgap::taxon::Taxon;
let taxon = "1\tFelis catus\tspecies\t4\t\x01".parse::<Taxon>();
// Will return: Taxon {
//                  id: 1,
//                  name: "Felis catus",
//                  rank: Rank::Species,
//                  parent: 4,
//                  valid: true
//              }

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Taxon

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

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

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

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

impl StructuralPartialEq for Taxon