hyperlit-model 0.1.0

A software documentation tool documentation embedded in source files - model crate
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

use crate::last_modification_info::LastModificationInfo;
use crate::location::Location;

pub type SegmentId = u32;

#[derive(Debug, Clone, PartialEq)]
pub struct Segment {
    /// document-wide unique identifier
    pub id: SegmentId,
    /// title of this segment
    pub title: String,
    /// tags of this segment
    pub tags: Vec<String>,
    /// content text of this segment - may be markdown formatted
    pub text: String,
    /// location of this segment
    pub location: Location,
    /// whether the segment is already included in the output
    pub location_url: Option<String>,
    /// url of this location (e.g. in github, etc)
    pub is_included: bool,
    /// last modification info, usually from git
    pub last_modification: LastModificationInfo,
}

impl Segment {
    pub fn new(
        id: SegmentId,
        title: impl Into<String>,
        tags: Vec<String>,
        text: impl Into<String>,
        location: Location,
    ) -> Segment {
        Segment {
            id,
            title: title.into(),
            tags,
            text: text.into(),
            location,
            is_included: false,
            last_modification: LastModificationInfo::default(),
            location_url: None,
        }
    }
}

pub fn segments_sort_by_title(segments: &mut [&Segment]) {
    segments.sort_by(|a, b| a.title.cmp(&b.title));
}