Enum JsonFormat

Source
pub enum JsonFormat {
    NodeLink,
    Tree,
}
Expand description

We can handle 2 kinds of JSON formats:

  1. the node link format
  2. the tree format

The node link format comes from an old version of NetworkX and looks like the following: {'nodes': [{'id': 'A'}, {'id': 'B'}], 'links': [{'source': 0, 'target': 1}]} This format is only used as legacy and is not recommended for new projects as it’s easy to mess up and not even supported anymore by NetworkX.

The tree format is a more natural looking format (only id is required):

{
    "id": "1",
    "name": "root",
    "rank": "no rank",
    "children": [
        {
            "id": "2",
            "name": "Bacteria",
            "rank": "no rank",
            "children": [
                {
                    "id": "562",
                    "name": "Escherichia coli",
                    "rank": "species",
                }
            ]
        }
    ]

For both formats, you can add more data on each node object and these will be available after loading. If a rank propery is present, it will be parsed as a NCBI rank.

Variants§

The node link format is made of 2 arrays:

  1. the nodes with their taxonomic info. Internal (integer) IDs are the node’s position in the nodes array
  2. the links between each node: a source node has a parent node. The nodes are represented by indices in the nodes array Only use that format if you have existing taxonomies in that format.
§

Tree

The preferred format

Trait Implementations§

Source§

impl PartialEq for JsonFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for JsonFormat

Source§

impl StructuralPartialEq for JsonFormat

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> 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, 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.