refget-model 0.1.0

Domain types for GA4GH refget Sequences and Sequence Collections APIs
Documentation 
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

//! Sequence metadata types for the refget Sequences API.

use serde::{Deserialize, Serialize};

/// A naming authority alias for a sequence.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Alias {
    /// The naming authority (e.g. "insdc", "ensembl").
    pub naming_authority: String,
    /// The identifier value within that authority.
    pub value: String,
}

/// Metadata for a single sequence, as returned by the `/sequence/{digest}/metadata` endpoint.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SequenceMetadata {
    /// MD5 hex digest of the sequence.
    pub md5: String,
    /// GA4GH sha512t24u digest of the sequence.
    #[serde(rename = "ga4gh")]
    pub sha512t24u: String,
    /// Length of the sequence in bases.
    pub length: u64,
    /// Known aliases for this sequence.
    pub aliases: Vec<Alias>,
    /// Whether this sequence is circular (e.g. mitochondrial genome, bacterial chromosome).
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub circular: bool,
}