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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
use std::fs::File;
use std::io::Write;
use std::path::PathBuf;
use anyhow::{anyhow, Context};
use crate::osm::model::bounding_box::BoundingBox;
use crate::osm::model::element::Element;
use crate::osm::pbf::compression_type::CompressionType;
use crate::osm::pbf::element_accumulator::ElementAccumulator;
use crate::osm::pbf::file_block::FileBlock;
use crate::osm::pbf::file_block_metadata::FileBlockMetadata;
use crate::osm::pbf::file_info::FileInfo;
use crate::osm::pbf::osm_data::OsmData;
use crate::osm::pbf::osm_header::OsmHeader;
/// *.osm.pbf file reader
///
/// Write an ordered *.osm.pbf file split into blocks of 8000 or less elements of the same variant -
/// Nodes, Ways, Relations.
/// Example:
/// ```
///
/// use std::path::PathBuf;
/// use osm_io::osm::model::element::Element;
/// use osm_io::osm::pbf;
/// use osm_io::osm::pbf::compression_type::CompressionType;
/// use osm_io::osm::pbf::file_info::FileInfo;
/// fn example() -> Result<(), anyhow::Error> {
/// let input_path = PathBuf::from("./tests/fixtures/malta-230109.osm.pbf");
/// let output_path = PathBuf::from("./target/results/malta-230109.osm.pbf");
/// let reader = pbf::reader::Reader::new(&input_path)?;
/// let mut file_info = FileInfo::default();
/// file_info.with_writingprogram_str("pbf-io-example");
/// let mut writer = pbf::writer::Writer::from_file_info(
/// output_path,
/// file_info,
/// CompressionType::Zlib,
/// )?;
///
/// writer.write_header()?;
/// for element in reader.elements()? {
/// let mut filtered_out = false;
/// match &element {
/// Element::Node { node: _ } => {}
/// Element::Way { way: _ } => {}
/// Element::Relation { relation: _ } => {}
/// Element::Sentinel => {
/// filtered_out = true;
/// }
/// }
/// if !filtered_out {
/// writer.write_element(element)?;
/// }
/// }
/// writer.close()?;
/// Ok(())
/// }
/// ```
pub struct Writer {
path: PathBuf,
file_info: FileInfo,
compression_type: CompressionType,
file: File,
element_accumulator: ElementAccumulator,
}
impl Writer {
/// Create a new [Writer] from [FileInfo]
pub fn from_file_info(
path: PathBuf,
file_info: FileInfo,
compression_type: CompressionType,
) -> Result<Writer, anyhow::Error> {
let file = File::create(path.clone())
.with_context(|| anyhow!("path: {}", path.display()))?;
Ok(
Writer {
path: path.clone(),
file_info,
compression_type,
file,
element_accumulator: ElementAccumulator::new(),
}
)
}
/// Create a new [Writer]
pub fn new(
path: PathBuf,
program_name: &str,
data_source: &str,
osmosis_replication_timestamp: Option<i64>,
osmosis_replication_sequence_number: Option<i64>,
osmosis_replication_base_url: Option<String>,
compression_type: CompressionType,
precomputed_bounding_box: Option<BoundingBox>,
contains_history: bool,
) -> Result<Writer, anyhow::Error> {
let mut required_features = vec![
"OsmSchema-V0.6".to_string(),
"DenseNodes".to_string(),
];
if contains_history {
required_features.push("HistoricalInformation".to_string());
}
let optional_features = vec![
"Sort.Type_then_ID".to_string(),
];
let writingprogram = Some(program_name.to_string());
let source = Some(data_source.to_string());
let file_info = FileInfo::new(
precomputed_bounding_box,
required_features,
optional_features,
writingprogram,
source,
osmosis_replication_timestamp,
osmosis_replication_sequence_number,
osmosis_replication_base_url,
);
Self::from_file_info(path, file_info, compression_type)
}
/// Write the *.osm.pbf file header.
///
/// Must be called before writing elements. That means that all header values, specifically the
/// bounding box must be calculated before writing the file. I some cases that can incur a
/// costly additional iteration.
pub fn write_header(&mut self) -> Result<(), anyhow::Error> {
let file_block = FileBlock::from_header(
OsmHeader::from_file_info(self.file_info.clone())
);
self.write_file_block(file_block)
}
/// Low level API to write a [FileBlock]
pub fn write_file_block(&mut self, file_block: FileBlock) -> Result<(), anyhow::Error> {
let (blob_header, blob_body) = FileBlock::serialize(&file_block, self.compression_type.clone())?;
self.write_blob(blob_header, blob_body)
}
/// Low level API to write a bytes of a blob
pub fn write_blob(&mut self, blob_header: Vec<u8>, blob_body: Vec<u8>) -> Result<(), anyhow::Error> {
let blob_header_len: i32 = blob_header.len() as i32;
self.file.write(&blob_header_len.to_be_bytes())?;
self.file.write(&blob_header)?;
self.file.write(&blob_body)?;
self.file.flush()?;
Ok(())
}
/// Write element
///
/// Elements must be ordered, that is each element must be less then or equal to the following
/// element
pub fn write_element(&mut self, element: Element) -> Result<(), anyhow::Error> {
let elements = self.element_accumulator.add(element);
match elements {
None => {}
Some(elements) => {
self.write_elements(elements)?;
}
}
Ok(())
}
/// Write elements
///
/// Elements must be ordered, that is each element must be less then or equal to the following
/// element
pub fn write_elements(&mut self, elements: Vec<Element>) -> Result<(), anyhow::Error> {
let index = self.element_accumulator.index();
let data = FileBlock::Data {
metadata: FileBlockMetadata::new(
"OSMData".to_string(),
index,
),
data: OsmData::from_elements(elements, None),
};
self.write_file_block(data)?;
Ok(())
}
/// Flush the internal buffers.
///
/// Must be called in the end to write any elements accumulated in internal buffers
pub fn close(&mut self) -> Result<(), anyhow::Error> {
let elements = self.element_accumulator.elements();
if elements.len() > 0 {
self.write_elements(elements)?;
}
Ok(())
}
/// Output path
pub fn path(&self) -> &PathBuf {
&self.path
}
}