dvb 0.8.0

An unofficial crate to query publicly accessible API methods for Dresden's public transport system.
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

//! Departure monitor API types and functions.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{
    DvbResponse,
    common::{ArrivalState, Mot},
    error::Result,
    time::DvbTime,
};

#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Platform {
    pub name: String,
    /// Either `"Platform"` or `"Railtrack"`.
    pub r#type: String,
}

#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Diva {
    pub number: String,
    pub network: String,
}

#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Departure {
    pub id: String,
    pub dl_id: Option<String>,
    pub line_name: String,
    pub direction: String,
    pub platform: Option<Platform>,
    pub mot: Mot,
    pub scheduled_time: Option<DvbTime>,
    pub real_time: Option<DvbTime>,
    pub state: Option<ArrivalState>,
    pub route_changes: Option<Vec<String>>,
    pub diva: Option<Diva>,
    #[serde(default)]
    pub cancel_reasons: Vec<String>,
    pub occupancy: Option<String>,
}

#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct DepartureMonitor {
    pub name: Option<String>,
    pub place: Option<String>,
    pub departures: Option<Vec<Departure>>,
}

impl DepartureMonitor {
    pub fn next_line<'a>(&'a self, line_name: &str) -> Option<&'a Departure> {
        if let Some(ref deps) = self.departures {
            deps.iter().find(|dep| dep.line_name == line_name)
        } else {
            None
        }
    }
}

const MONITOR_URL: &str = "https://webapi.vvo-online.de/dm";

#[derive(Serialize, Clone, Debug, Default)]
pub struct Params<'a> {
    /// The stop ID to monitor.
    pub stopid: &'a str,
    /// Maximum number of departures to return.
    pub limit: Option<u32>,
    /// Time for the departure query.
    pub time: Option<&'a str>,
    /// If true, time is interpreted as arrival time.
    pub isarrival: Option<bool>,
    /// Include short-term changes.
    pub shorttermchanges: Option<bool>,
    /// Filter by mode of transport.
    pub mot: Option<&'a [Mot]>,
}

/// Fetches upcoming departures from a specified stop using the VVO WebAPI.
///
/// # Arguments
/// * `params` - Parameters including stop ID, limit, time, and optional filters.
///
/// # Returns
/// * `Result<DvbResponse<DepartureMonitor>>` - The parsed response containing departure information.
///
/// Endpoint: `https://webapi.vvo-online.de/dm`
pub async fn departure_monitor<'a>(params: Params<'a>) -> Result<DvbResponse<DepartureMonitor>> {
    let result = reqwest::Client::new()
        .post(MONITOR_URL)
        .json(&params)
        .send()
        .await?
        .json()
        .await?;

    Ok(result)
}