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

//! An unofficial crate to query publicly accessible API methods for Dresden's public transport system.
//!
//! Currently the endpoints are supported:
//!
//! ## Station
//! `http://widgets.vvo-online.de/abfahrtsmonitor/Haltestelle.do`
//!

mod common;
pub mod error;
mod time;

pub mod lines;
pub mod monitor;
pub mod poi;
pub mod point;
pub mod route;
pub mod route_changes;
pub mod trip;

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

use crate::{
    monitor::DepartureMonitor,
    point::{Found, Params, point_finder},
};

/// Search for stops by name using the VVO PointFinder API.
///
/// This is a convenience wrapper for [`point::point_finder`] with `stops_only = true`.
/// For more advanced queries, use [`point::point_finder`] directly.
///
/// Endpoint: `https://webapi.vvo-online.de/pointfinder`
pub async fn find_stops(query: &str) -> Result<DvbResponse<Found>> {
    point_finder(&Params {
        query,
        stops_only: true,
        ..Default::default()
    })
    .await
}

/// Search for nearby and assigned stops using the VVO PointFinder API.
///
/// This is a convenience wrapper for [`point::point_finder`] with `stops_only = false` and `assigedstops = true`.
/// For more advanced queries, use [`point::point_finder`] directly.
///
/// Endpoint: `https://webapi.vvo-online.de/pointfinder`
pub async fn find_nearby_stops(query: &str) -> Result<DvbResponse<Found>> {
    point_finder(&Params {
        query,
        stops_only: false,
        assigedstops: true,
        ..Default::default()
    })
    .await
}

/// Search for points of interest (POIs) using the VVO PointFinder API.
///
/// This is a convenience wrapper for [`point::point_finder`] with `stops_only = false`.
/// For more advanced queries, use [`point::point_finder`] directly.
///
/// Endpoint: `https://webapi.vvo-online.de/pointfinder`
pub async fn find_pois(query: &str) -> Result<DvbResponse<Found>> {
    point_finder(&Params {
        query,
        stops_only: false,
        ..Default::default()
    })
    .await
}

/// Get upcoming departures for a stop using the VVO Departure Monitor API.
///
/// This is a convenience wrapper for [`monitor::departure_monitor`] with default parameters.
/// For more advanced queries (e.g., filtering by mode of transport, custom limits, etc.), use [`monitor::departure_monitor`] directly.
///
/// Endpoint: `https://webapi.vvo-online.de/dm`
pub async fn monitor_departures(stopid: &str) -> Result<DvbResponse<DepartureMonitor>> {
    let monitor = monitor::departure_monitor(monitor::Params {
        stopid,
        mot: None,
        limit: Some(15),
        ..Default::default()
    })
    .await?;

    Ok(monitor)
}