foxglove 0.18.0

Foxglove SDK
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

use crate::Schema;

/// A service request or response schema.
#[derive(Debug, Clone)]
pub(crate) struct MessageSchema {
    pub encoding: String,
    pub schema: Schema,
}

/// A service schema.
#[derive(Debug, Clone)]
pub struct ServiceSchema {
    name: String,
    request: Option<MessageSchema>,
    response: Option<MessageSchema>,
}
impl ServiceSchema {
    /// Creates a new named service schema with an empty request and response.
    #[must_use]
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            request: None,
            response: None,
        }
    }

    /// Adds request schema information.
    #[must_use]
    pub fn with_request(mut self, encoding: impl Into<String>, schema: Schema) -> Self {
        self.request = Some(MessageSchema {
            encoding: encoding.into(),
            schema,
        });
        self
    }

    /// Adds response schema information.
    #[must_use]
    pub fn with_response(mut self, encoding: impl Into<String>, schema: Schema) -> Self {
        self.response = Some(MessageSchema {
            encoding: encoding.into(),
            schema,
        });
        self
    }

    /// Returns the name of the schema.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Returns the request schema.
    pub(crate) fn request(&self) -> Option<&MessageSchema> {
        self.request.as_ref()
    }

    /// Returns the response schema.
    pub(crate) fn response(&self) -> Option<&MessageSchema> {
        self.response.as_ref()
    }
}