1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104

#[cfg(any(feature = "python", feature = "python_test"))]
extern crate pyo3;

use std::fmt;
use std::result::Result as StdResult;

/// A wrapper type for taxonomy results.
/// Alias for `Result<T, failure::Error>`
pub type Result<T> = StdResult<T, TaxonomyError>;

/// A taxonomically-specific error
#[derive(Debug)]
pub enum TaxonomyError {
    /// The given key could not be found in the taxonomy.
    NoSuchKey {
        key: String,
    },
    /// The given name could not be found in the taxonomy.
    NoSuchName {
        name: String,
    },
    /// A string could not be parsed into a TaxRank.
    UnrecognizedRank {
        rank: String,
    },
    /// A string could not be parsed into a TaxRank.
    ImportError {
        line: usize,
        msg: String,
    },
    /// The taxonomy has an unrooted node or some other issue that breaks
    /// the assumption its a tree
    MalformedTree {
        tax_id: String,
    },
    CreationFailed {
        field: String,
    },
}

impl fmt::Display for TaxonomyError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TaxonomyError::NoSuchKey { key } => write!(f, "Key is not valid: {}", key),
            TaxonomyError::NoSuchName { name } => write!(f, "Name is not valid: {}", name),
            TaxonomyError::UnrecognizedRank { rank } => {
                write!(f, "Rank is not supported: {}", rank)
            }
            TaxonomyError::ImportError { line, msg } => {
                if *line != 0 {
                    write!(f, "Error importing at line {}: {}", line, msg)
                } else {
                    write!(f, "Error importing: {}", msg)
                }
            }
            TaxonomyError::MalformedTree { tax_id } => {
                write!(f, "Taxonomy is not a tree; broken at {}", tax_id)
            }
            TaxonomyError::CreationFailed { field } => {
                write!(f, "Each taxa must have only one {}", field)
            }
        }
    }
}

impl From<serde_json::error::Error> for TaxonomyError {
    fn from(error: serde_json::error::Error) -> Self {
        TaxonomyError::ImportError {
            line: error.line(),
            msg: error.to_string(),
        }
    }
}

impl From<quick_xml::Error> for TaxonomyError {
    fn from(error: quick_xml::Error) -> Self {
        TaxonomyError::ImportError {
            line: 0,
            msg: error.to_string(),
        }
    }
}

impl From<std::io::Error> for TaxonomyError {
    fn from(error: std::io::Error) -> Self {
        TaxonomyError::ImportError {
            line: 0,
            msg: error.to_string(),
        }
    }
}

mod base;
pub mod edit;
pub mod formats;
#[cfg(any(feature = "python", feature = "python_test"))]
pub mod python;
mod rank;
mod taxonomy;
pub mod weights;

pub use crate::base::GeneralTaxonomy;
pub use crate::rank::TaxRank;
pub use crate::taxonomy::Taxonomy;