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

use crate::segment::{Segment, SegmentId};
use hyperlit_base::result::HyperlitResult;

pub trait Database {
    fn add_segments(&mut self, segment: Vec<Segment>) -> HyperlitResult<()>;

    fn get_all_segments(&self) -> HyperlitResult<Vec<&Segment>>;
    fn get_segment_by_id(&self, id: SegmentId) -> HyperlitResult<&Segment>;

    fn get_segments_by_tag(&self, tag: &str) -> HyperlitResult<Vec<&Segment>> {
        Ok(self
            .get_all_segments()?
            .into_iter()
            .filter(|segment| segment.tags.iter().any(|segment_tag| segment_tag == tag))
            .collect())
    }

    fn set_segment_included(&mut self, id: SegmentId) -> HyperlitResult<()>;
}

pub type DatabaseBox = Box<dyn Database>;