hpo 0.12.0

Human Phenotype Ontology Similarity
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
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

//! Create [`HpoTermInternal`] from binary representation
//! and vice versa

use super::Bytes;
use crate::term::internal::HpoTermInternal;
use crate::HpoError;

/// Creates an `HpoTermInternal` from bytes
///
/// The binary layout is defined as:
///
/// | Byte offset | Number of bytes | Description |
/// | --- | --- | --- |
/// | 0 | 4 | The total length of the binary data blob as big-endian `u32` |
/// | 4 | 4 | The Term ID as big-endian `u32` |
/// | 8 | 1 | The length of the Term Name (converted to a u8 vector) as a `u8` |
/// | 9 | n | The Term name as u8 vector. If the name has more than 255 bytes, it is trimmed to 255 |
///
/// # Panics
///
/// This method will panic if the total byte length is longer than `u32::MAX`
pub(crate) fn from_bytes_v1(bytes: Bytes) -> Result<HpoTermInternal, HpoError> {
    if bytes.len() < 4 + 4 + 1 {
        return Err(HpoError::ParseBinaryError);
    }
    let total_len = u32::from_be_bytes([bytes[0], bytes[1], bytes[2], bytes[3]]);

    let id = u32::from_be_bytes([bytes[4], bytes[5], bytes[6], bytes[7]]);
    let name_len = bytes[8] as usize;

    if bytes.len() < 4 + 4 + 1 + name_len {
        return Err(HpoError::ParseBinaryError);
    }

    let Ok(name) = String::from_utf8(bytes[9..total_len as usize].to_vec()) else {
        return Err(HpoError::ParseBinaryError);
    };
    Ok(HpoTermInternal::new(name, id.into()))
}

/// Creates an `HpoTermInternal` from bytes
///
/// The binary layout is defined as:
///
/// | Byte offset | Number of bytes | Description |
/// | --- | --- | --- |
/// | 0 | 4 | The total length of the binary data blob as big-endian `u32` |
/// | 4 | 4 | The Term ID as big-endian `u32` |
/// | 8 | 1 | The length of the Term Name (converted to a u8 vector) as a `u8` |
/// | 9 | n | The Term name as u8 vector. If the name has more than 255 bytes, it is trimmed to 255 |
/// | 9 + n | 1 | Flags, currently only obsolete
/// | 10 + n | 4 | Term ID of a replacement term as big-endian `u32` or 0 if None |
///
/// # Panics
///
/// This method will panic if the total byte length is longer than `u32::MAX`
pub(crate) fn from_bytes_v2(bytes: Bytes) -> Result<HpoTermInternal, HpoError> {
    if bytes.len() < 14 {
        return Err(HpoError::ParseBinaryError);
    }

    let id = u32::from_be_bytes([bytes[4], bytes[5], bytes[6], bytes[7]]);
    let name_len = bytes[8] as usize;

    if bytes.len() < 14 + name_len {
        return Err(HpoError::ParseBinaryError);
    }

    let Ok(name) = String::from_utf8(bytes[9..9 + name_len].to_vec()) else {
        return Err(HpoError::ParseBinaryError);
    };
    let mut term = HpoTermInternal::new(name, id.into());

    if bytes[9 + name_len] & 1u8 == 1u8 {
        *term.obsolete_mut() = true;
    }
    let offset = 10 + name_len;
    let replacement_id = u32::from_be_bytes([
        bytes[offset],
        bytes[offset + 1],
        bytes[offset + 2],
        bytes[offset + 3],
    ]);
    if replacement_id != 0 {
        *term.replacement_mut() = Some(replacement_id.into());
    }
    Ok(term)
}