switchback-protobuf 0.0.1-0.dev.4

Protobuf parser for the switchback framework.
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
89
90
91
92
93
94
95

//! `ContractFamily` and companion strategy for protobuf.

use switchback_traits::{
    CompanionDiscovery, CompanionStrategy, ContractFamily, RawDoc, SupportedVersion, VersionStatus,
};

use crate::category::ProtobufCategory;
use crate::link::ProtobufLinkExtractor;

#[derive(Clone, Copy, Debug, Default)]
pub struct ProtobufCompanion;

impl CompanionStrategy for ProtobufCompanion {
    fn discovery(&self) -> CompanionDiscovery {
        CompanionDiscovery::Ancestors
    }

    fn output_name(&self, source_dir: &[&str], stem: &str) -> String {
        switchback_traits::companion_output_name_from_segments(source_dir, stem)
    }

    fn companion_media_types(&self) -> &'static [&'static str] {
        &["text/markdown"]
    }
}

#[derive(Clone, Copy, Debug, Default)]
pub struct ProtobufFamily;

impl ContractFamily for ProtobufFamily {
    type Category = ProtobufCategory;
    type LinkExtractor = ProtobufLinkExtractor;
    type CompanionStrategy = ProtobufCompanion;

    fn name(&self) -> &'static str {
        "protobuf"
    }

    fn fence_language(&self) -> &'static str {
        "protobuf"
    }

    fn default_title(&self) -> &'static str {
        "Protobuf documentation"
    }

    fn default_markdown_root(&self) -> &'static str {
        "packages"
    }

    fn extensions(&self) -> &'static [&'static str] {
        &[".proto"]
    }

    fn companion_strategy(&self) -> &Self::CompanionStrategy {
        &ProtobufCompanion
    }

    fn category_names(&self) -> &'static [&'static str] {
        &["service", "schema", "operation"]
    }

    fn detect_version(&self, _raw: &RawDoc) -> Option<switchback_traits::SpecVersion> {
        None
    }

    fn supported_versions(&self) -> &'static [SupportedVersion] {
        &[
            SupportedVersion {
                version: "proto3",
                status: VersionStatus::Latest,
            },
            SupportedVersion {
                version: "2023",
                status: VersionStatus::Latest,
            },
            SupportedVersion {
                version: "2024",
                status: VersionStatus::Latest,
            },
        ]
    }

    fn link_extractor(&self) -> &Self::LinkExtractor {
        &ProtobufLinkExtractor
    }

    fn supported_protocols(&self) -> &'static [&'static str] {
        &["grpc"]
    }

    fn default_protocol(&self) -> &'static str {
        "grpc"
    }
}