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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
use enums::{ByteOrder, OutputDimension}; use crate::{ContextHandle, Geometry, GResult, AsRaw, ContextHandling, ContextInteractions}; use context_handle::PtrWrap; use geos_sys::*; use std::sync::Arc; use error::Error; use enums::TryFrom; use c_vec::CVec; /// The `WKBWriter` type is used to generate `HEX` or `WKB` formatted output from [`Geometry`]. /// /// # Example /// /// ``` /// use geos::{ContextHandling, Geometry, WKBWriter}; /// /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new_with_context(point_geom.clone_context()) /// .expect("Failed to create WKBWriter"); /// /// // Output as WKB /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// assert_eq!(Geometry::new_from_wkb(&v).unwrap().to_wkt_precision(1).unwrap(), /// "POINT (2.5 2.5)"); /// /// // Output as HEX /// let v: Vec<u8> = writer.write_hex(&point_geom).unwrap().into(); /// assert_eq!(Geometry::new_from_hex(&v).unwrap().to_wkt_precision(1).unwrap(), /// "POINT (2.5 2.5)"); /// ``` pub struct WKBWriter<'a> { ptr: PtrWrap<*mut GEOSWKBWriter>, context: Arc<ContextHandle<'a>>, } impl<'a> WKBWriter<'a> { /// Creates a new `WKBWriter` instance. /// /// # Example /// /// ``` /// use geos::{Geometry, WKBWriter}; /// /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// assert_eq!(Geometry::new_from_wkb(&v).unwrap().to_wkt_precision(1).unwrap(), /// "POINT (2.5 2.5)"); /// ``` pub fn new() -> GResult<WKBWriter<'a>> { match ContextHandle::init_e(Some("WKBWriter::new")) { Ok(context_handle) => Self::new_with_context(Arc::new(context_handle)), Err(e) => Err(e), } } /// Creates a new `WKBWriter` instance with a given context. /// /// # Example /// /// ``` /// use geos::{ContextHandling, Geometry, WKBWriter}; /// /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new_with_context(point_geom.clone_context()) /// .expect("Failed to create WKBWriter"); /// /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// assert_eq!(Geometry::new_from_wkb(&v).unwrap().to_wkt_precision(1).unwrap(), /// "POINT (2.5 2.5)"); /// ``` pub fn new_with_context(context: Arc<ContextHandle<'a>>) -> GResult<WKBWriter<'a>> { unsafe { let ptr = GEOSWKBWriter_create_r(context.as_raw()); WKBWriter::new_from_raw(ptr, context, "new_with_context") } } pub(crate) unsafe fn new_from_raw( ptr: *mut GEOSWKBWriter, context: Arc<ContextHandle<'a>>, caller: &str, ) -> GResult<WKBWriter<'a>> { if ptr.is_null() { let extra = if let Some(x) = context.get_last_error() { format!("\nLast error: {}", x) } else { String::new() }; return Err(Error::NoConstructionFromNullPtr(format!("WKBWriter::{}{}", caller, extra))); } Ok(WKBWriter { ptr: PtrWrap(ptr), context }) } /// Writes out the given `geometry` as WKB format. /// /// # Example /// /// ``` /// use geos::{Geometry, WKBWriter}; /// /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// let expected = vec![1u8, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 64, 0, 0, 0, 0, 0, 0, 4, 64]; /// assert_eq!(v, expected); /// ``` pub fn write_wkb(&self, geometry: &Geometry<'_>) -> GResult<CVec<u8>> { let mut size = 0; unsafe { let ptr = GEOSWKBWriter_write_r(self.get_raw_context(), self.as_raw(), geometry.as_raw(), &mut size); if ptr.is_null() { Err(Error::NoConstructionFromNullPtr( "WKBWriter::write_wkb failed: GEOSWKBWriter_writeHEX_r returned null pointer".to_owned()) ) } else { Ok(CVec::new(ptr, size as _)) } } } /// Writes out the given `geometry` as WKB format. /// /// # Example /// /// ``` /// use geos::{Geometry, WKBWriter}; /// /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// let v: Vec<u8> = writer.write_hex(&point_geom).unwrap().into(); /// let expected = vec![48u8,49,48,49,48,48,48,48,48,48,48,48,48,48,48,48,48,48,48,48,48,48,48, /// 52,52,48,48,48,48,48,48,48,48,48,48,48,48,48,48,52,52,48]; /// assert_eq!(v, expected); /// ``` pub fn write_hex(&self, geometry: &Geometry<'_>) -> GResult<CVec<u8>> { let mut size = 0; unsafe { let ptr = GEOSWKBWriter_writeHEX_r(self.get_raw_context(), self.as_raw(), geometry.as_raw(), &mut size); if ptr.is_null() { Err(Error::NoConstructionFromNullPtr( "WKBWriter::write_hex failed: GEOSWKBWriter_writeHEX_r returned null pointer".to_owned()) ) } else { Ok(CVec::new(ptr, size as _)) } } } /// Sets the number of dimensions to be used when calling [`WKBWriter::write_wkb`] or /// [`WKBWriter::write_hex`]. By default, it is 2. /// /// # Example /// /// ``` /// use geos::{Geometry, OutputDimension, WKBWriter, WKTWriter}; /// /// let mut wkt_writer = WKTWriter::new().expect("Failed to create WKTWriter"); /// wkt_writer.set_output_dimension(OutputDimension::ThreeD); /// wkt_writer.set_trim(true); /// /// let point_geom = Geometry::new_from_wkt("POINT (1.1 2.2 3.3)").expect("Invalid geometry"); /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// let geom = Geometry::new_from_wkb(&v).unwrap(); /// assert_eq!(wkt_writer.write(&geom).unwrap(), "POINT (1.1 2.2)"); /// /// writer.set_output_dimension(OutputDimension::ThreeD); /// let v: Vec<u8> = writer.write_wkb(&point_geom).unwrap().into(); /// let geom = Geometry::new_from_wkb(&v).unwrap(); /// assert_eq!(wkt_writer.write(&geom).unwrap(), "POINT Z (1.1 2.2 3.3)"); /// ``` pub fn set_output_dimension(&mut self, dimension: OutputDimension) { unsafe { GEOSWKBWriter_setOutputDimension_r(self.get_raw_context(), self.as_raw(), dimension.into()) } } /// Returns the number of dimensions to be used when calling [`WKBWriter::write`]. By default, /// it is 2. /// /// # Example /// /// ``` /// use geos::{OutputDimension, WKBWriter}; /// /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// assert_eq!(writer.get_out_dimension(), Ok(OutputDimension::TwoD)); /// writer.set_output_dimension(OutputDimension::ThreeD); /// assert_eq!(writer.get_out_dimension(), Ok(OutputDimension::ThreeD)); /// ``` pub fn get_out_dimension(&self) -> GResult<OutputDimension> { unsafe { let out = GEOSWKBWriter_getOutputDimension_r(self.get_raw_context(), self.as_raw()); OutputDimension::try_from(out).map_err(|e| Error::GenericError(e.to_owned())) } } /// Gets WKB byte order. /// /// # Example /// /// ``` /// use geos::{ByteOrder, WKBWriter}; /// /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// writer.set_wkb_byte_order(ByteOrder::LittleEndian); /// assert_eq!(writer.get_wkb_byte_order(), Ok(ByteOrder::LittleEndian)); /// ``` pub fn get_wkb_byte_order(&self) -> GResult<ByteOrder> { unsafe { let out = GEOSWKBWriter_getByteOrder_r(self.get_raw_context(), self.as_raw()); ByteOrder::try_from(out).map_err(|e| Error::GenericError(e.to_owned())) } } /// Sets WKB byte order. /// /// # Example /// /// ``` /// use geos::{WKBWriter, ByteOrder}; /// /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// writer.set_wkb_byte_order(ByteOrder::LittleEndian); /// assert_eq!(writer.get_wkb_byte_order(), Ok(ByteOrder::LittleEndian)); /// ``` pub fn set_wkb_byte_order(&mut self, byte_order: ByteOrder) { unsafe { GEOSWKBWriter_setByteOrder_r(self.get_raw_context(), self.as_raw(), byte_order.into()) } } /// Gets if output will include SRID. /// /// # Example /// /// ``` /// use geos::WKBWriter; /// /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// writer.set_include_SRID(true); /// assert_eq!(writer.get_include_SRID(), Ok(true)); /// ``` #[allow(non_snake_case)] pub fn get_include_SRID(&self) -> GResult<bool> { unsafe { let out = GEOSWKBWriter_getIncludeSRID_r(self.get_raw_context(), self.as_raw()); if out < 0 { Err(Error::GenericError("GEOSWKBWriter_getIncludeSRID_r failed".to_owned())) } else { Ok(out != 0) } } } /// Sets if output will include SRID. /// /// # Example /// /// ``` /// use geos::WKBWriter; /// /// let mut writer = WKBWriter::new().expect("Failed to create WKBWriter"); /// /// writer.set_include_SRID(true); /// assert_eq!(writer.get_include_SRID(), Ok(true)); /// ``` #[allow(non_snake_case)] pub fn set_include_SRID(&self, include_SRID: bool) { unsafe { GEOSWKBWriter_setIncludeSRID_r(self.get_raw_context(), self.as_raw(), include_SRID as _) } } } unsafe impl<'a> Send for WKBWriter<'a> {} unsafe impl<'a> Sync for WKBWriter<'a> {} impl<'a> Drop for WKBWriter<'a> { fn drop(&mut self) { unsafe { GEOSWKBWriter_destroy_r(self.get_raw_context(), self.as_raw()) }; } } impl<'a> ContextInteractions<'a> for WKBWriter<'a> { /// Set the context handle to the `WKBWriter`. /// /// ``` /// use geos::{ContextInteractions, ContextHandle, WKBWriter}; /// /// let context_handle = ContextHandle::init().expect("invalid init"); /// let mut writer = WKBWriter::new().expect("failed to create WKT writer"); /// context_handle.set_notice_message_handler(Some(Box::new(|s| println!("new message: {}", s)))); /// writer.set_context_handle(context_handle); /// ``` fn set_context_handle(&mut self, context: ContextHandle<'a>) { self.context = Arc::new(context); } /// Get the context handle of the `WKBWriter`. /// /// ``` /// use geos::{ContextInteractions, WKBWriter}; /// /// let mut writer = WKBWriter::new().expect("failed to create WKT writer"); /// let context = writer.get_context_handle(); /// context.set_notice_message_handler(Some(Box::new(|s| println!("new message: {}", s)))); /// ``` fn get_context_handle(&self) -> &ContextHandle<'a> { &self.context } } impl<'a> AsRaw for WKBWriter<'a> { type RawType = *mut GEOSWKBWriter; fn as_raw(&self) -> Self::RawType { *self.ptr } } impl<'a> ContextHandling for WKBWriter<'a> { type Context = Arc<ContextHandle<'a>>; fn get_raw_context(&self) -> GEOSContextHandle_t { self.context.as_raw() } fn clone_context(&self) -> Arc<ContextHandle<'a>> { Arc::clone(&self.context) } }