foxglove 0.24.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
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

use std::sync::Arc;

use crate::{ChannelId, FoxgloveError, Metadata, RawChannel, Sink, SinkId};
use parking_lot::Mutex;

pub struct MockSink(SinkId);
impl Default for MockSink {
    fn default() -> Self {
        Self(SinkId::next())
    }
}

impl Sink for MockSink {
    fn id(&self) -> SinkId {
        self.0
    }

    fn log(
        &self,
        _channel: &RawChannel,
        _msg: &[u8],
        _metadata: &Metadata,
    ) -> Result<(), FoxgloveError> {
        Ok(())
    }
}

pub struct LogCall {
    pub channel_id: ChannelId,
    pub msg: Vec<u8>,
    pub metadata: Metadata,
}

type AddChannelFn = Box<dyn Fn(&[&Arc<RawChannel>]) -> Option<Vec<ChannelId>> + Send + Sync>;

pub struct RecordingSink {
    id: SinkId,
    auto_subscribe: bool,
    add_channels_func: Option<AddChannelFn>,
    recorded: Mutex<Vec<LogCall>>,
}

impl RecordingSink {
    pub fn new() -> Self {
        Self {
            id: SinkId::next(),
            auto_subscribe: true,
            add_channels_func: None,
            recorded: Mutex::new(Vec::new()),
        }
    }

    pub fn add_channels<F>(mut self, func: F) -> Self
    where
        F: Fn(&[&Arc<RawChannel>]) -> Option<Vec<ChannelId>> + Send + Sync + 'static,
    {
        self.add_channels_func = Some(Box::new(func));
        self
    }

    pub fn auto_subscribe(mut self, value: bool) -> Self {
        self.auto_subscribe = value;
        self
    }

    pub fn take_messages(&self) -> Vec<LogCall> {
        std::mem::take(&mut *self.recorded.lock())
    }
}

impl Sink for RecordingSink {
    fn id(&self) -> SinkId {
        self.id
    }

    fn auto_subscribe(&self) -> bool {
        self.auto_subscribe
    }

    fn add_channels(&self, channels: &[&Arc<RawChannel>]) -> Option<Vec<ChannelId>> {
        if let Some(func) = self.add_channels_func.as_ref() {
            func(channels)
        } else {
            None
        }
    }

    fn log(
        &self,
        channel: &RawChannel,
        msg: &[u8],
        metadata: &Metadata,
    ) -> Result<(), FoxgloveError> {
        let mut recorded = self.recorded.lock();
        recorded.push(LogCall {
            channel_id: channel.id(),
            msg: msg.to_vec(),
            metadata: *metadata,
        });
        Ok(())
    }
}

pub struct ErrorSink(SinkId);
impl Default for ErrorSink {
    fn default() -> Self {
        Self(SinkId::next())
    }
}

#[derive(Debug, thiserror::Error)]
struct StrError(&'static str);

impl std::fmt::Display for StrError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.0)
    }
}

impl Sink for ErrorSink {
    fn id(&self) -> SinkId {
        self.0
    }

    fn log(
        &self,
        _channel: &RawChannel,
        _msg: &[u8],
        _metadata: &Metadata,
    ) -> Result<(), FoxgloveError> {
        Err(FoxgloveError::Unspecified(Box::new(StrError(
            "ErrorSink always fails",
        ))))
    }
}