skyway 0.5.0

A command-line OpenStreetMap file converter
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Reads OSM data into skyway.

use rayon::prelude::*;

#[cfg(feature = "cli")]
use clap::ValueEnum;

use std::{
    fs,
    io::{stdin, BufRead, BufReader, Read},
    path::PathBuf,
    sync::mpsc::{channel, Sender},
};

use crate::{
    chunks::{ChunkBuilder, ElementChunk},
    elements::Metadata,
    writers::*,
    SkywayError,
};

#[cfg(feature = "filter")]
use crate::filter::{build_filter, ElementFilter};

#[cfg(not(feature = "filter"))]
use std::convert::identity;

#[cfg(feature = "cli")]
use crate::FileFormatOptions;

#[cfg(feature = "json")]
mod json;
#[cfg(feature = "json")]
pub use json::JsonReader;

#[cfg(feature = "opl")]
mod opl;
#[cfg(feature = "opl")]
pub use opl::OplReader;

#[cfg(feature = "osmx")]
mod osmx;

#[cfg(feature = "pbf")]
mod pbf;
#[cfg(feature = "pbf")]
pub use pbf::PbfReader;

#[cfg(feature = "xml")]
mod xml;
#[cfg(feature = "xml")]
pub use xml::XmlReader;

/// Enum that represents the different input file formats skyway supports.
#[cfg(feature = "cli")]
#[derive(Clone, Debug, PartialEq, ValueEnum)]
pub enum InputFileFormat {
    #[cfg(feature = "json")]
    #[value(name = "json")]
    Json,
    #[cfg(feature = "opl")]
    #[value(name = "opl")]
    Opl,
    #[cfg(feature = "pbf")]
    #[value(name = "pbf")]
    Pbf,
    #[cfg(feature = "xml")]
    #[value(name = "xml", alias = "osm")]
    Xml,
}

#[cfg(feature = "cli")]
impl FileFormatOptions for InputFileFormat {
    fn format_error(ext: &str) -> SkywayError {
        SkywayError::UnknownInputFormat(ext.to_string())
    }
}

/// Enum that represents the different input file formats skyway supports.
#[cfg(not(feature = "cli"))]
#[derive(Clone, Debug, PartialEq)]
pub enum InputFileFormat {
    #[cfg(feature = "json")]
    Json,
    #[cfg(feature = "opl")]
    Opl,
    #[cfg(feature = "pbf")]
    Pbf,
    #[cfg(feature = "xml")]
    Xml,
}

pub fn open(path: PathBuf) -> Box<dyn Read + Send> {
    match fs::File::open(path) {
        Ok(f) => Box::new(f) as Box<dyn Read + Send>,
        Err(e) => panic!("Unable to open input file: {e:?}"),
    }
}

pub fn get_reader(src: Option<PathBuf>) -> Box<dyn BufRead + Send> {
    Box::new(BufReader::new(match src {
        Some(path) => open(path),
        None => Box::new(stdin()),
    }))
}

pub trait Reader: Sized {
    /// Create a new instance of this Reader

    /// Reads data into skyway.
    ///
    /// * `sender`: Sender for a channel of `Element`s.
    /// * `metadata_sender`: Sender for a channel of (1) `Metadata`.
    fn read_file(
        self,
        src: Option<PathBuf>,
        metadata_sender: Sender<Metadata>,
        chunk_builder: ChunkBuilder,
    ) -> impl ParallelIterator<Item = ElementChunk>;

    fn run_conversion(
        self,
        source: Option<PathBuf>,
        chunk_size: usize,
        #[cfg(feature = "filter")] filters: Vec<Box<dyn ElementFilter>>,
        output_format: OutputFileFormat,
        dest: Option<PathBuf>,
    ) -> Result<(), SkywayError> {
        let (metadata_sender, metadata_receiver) = channel();
        let chunk_builder = ChunkBuilder::new(chunk_size);

        #[cfg(feature = "filter")]
        let combined_filter = build_filter(filters);
        #[cfg(feature = "filter")]
        let chunk_iterator = self
            .read_file(source, metadata_sender, chunk_builder)
            .map(|chunk| combined_filter(chunk));

        #[cfg(not(feature = "filter"))]
        let chunk_iterator = self.read_file(source, metadata_sender, chunk_builder);

        #[allow(unreachable_patterns)]
        match output_format {
            #[cfg(feature = "json")]
            OutputFileFormat::Json => {
                JsonWriter { overpass: false }.write(chunk_iterator, metadata_receiver, dest)
            }
            //#[cfg(feature = "o5m")]
            // O5mWriter { }.write(chunk_iterator, metadata_receiver, dest)
            #[cfg(feature = "opl")]
            OutputFileFormat::Opl => OplWriter {}.write(chunk_iterator, metadata_receiver, dest),
            #[cfg(feature = "json")]
            OutputFileFormat::Overpass => {
                JsonWriter { overpass: true }.write(chunk_iterator, metadata_receiver, dest)
            }
            #[cfg(feature = "xml")]
            OutputFileFormat::Xml => XmlWriter {}.write(chunk_iterator, metadata_receiver, dest),
            _ => Err(SkywayError::UnexpectedError(
                "A file conversion was attempted with an unknown output format.".to_owned(),
            )),
        }
    }
}