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

//! Serde types for the remote data loader manifest JSON.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use serde_constant::ConstBool;
use serde_with::{base64::Base64, serde_as};
use std::num::NonZeroU16;

/// Manifest of data sources.
#[derive(Debug, Deserialize, Serialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct Manifest {
    /// Human-readable display name for this manifest.
    #[serde(default)]
    pub name: Option<String>,
    /// Data sources in this manifest.
    pub sources: Vec<DataSource>,
}

/// A data source from a manifest.
///
/// Sources can be either static files (supporting range requests for random access)
/// or streamed sources that must be read sequentially.
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase", rename_all_fields = "camelCase", untagged)]
pub enum DataSource {
    /// A static file that supports HTTP range requests.
    StaticFile {
        /// URL to fetch the file from.
        url: String,
        /// Marker indicating range request support (always true).
        #[allow(unused)]
        supports_range_requests: ConstBool<true>,
    },
    /// A streamed source that must be read sequentially.
    Streamed(StreamedSource),
}

/// A URL data source which does not support range requests.
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct StreamedSource {
    /// URL to fetch the data from. Can be absolute or relative.
    /// If `id` is absent, this must uniquely identify the data.
    pub url: String,
    /// Identifier for the data source. If present, this must be unique.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub id: Option<String>,
    /// Topics present in the data.
    pub topics: Vec<Topic>,
    /// Schemas present in the data.
    pub schemas: Vec<Schema>,
    /// Earliest timestamp of any message in the data source.
    ///
    /// You can provide a lower bound if this is not known exactly. This determines the start time of the seek bar in the Foxglove app.
    pub start_time: DateTime<Utc>,
    /// Latest timestamp of any message in the data.
    ///
    /// You can provide an upper bound if this is not known exactly. This determines the end time of the seek bar in the Foxglove app.
    pub end_time: DateTime<Utc>,
}

/// A topic in a streamed source.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq, Hash)]
#[serde(rename_all = "camelCase")]
pub struct Topic {
    /// Topic name.
    pub name: String,
    /// Message encoding (e.g. `"protobuf"`).
    pub message_encoding: String,
    /// Schema ID, if this topic has an associated schema.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema_id: Option<NonZeroU16>,
}

/// A schema in a streamed source.
#[serde_as]
#[derive(Debug, Deserialize, Serialize, PartialEq, Eq, Hash)]
#[serde(rename_all = "camelCase")]
pub struct Schema {
    /// Unique schema ID within this source.
    pub id: NonZeroU16,
    /// Schema name.
    pub name: String,
    /// Schema encoding (e.g. `"protobuf"`).
    pub encoding: String,
    /// Raw schema data, serialized as base64.
    #[serde_as(as = "Base64")]
    pub data: Box<[u8]>,
}