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
use crate::context_handle::with_context;
use crate::functions::*;
use crate::traits::as_raw_mut_impl;
use crate::{AsRaw, AsRawMut, CoordDimensions, GResult, Geom};
use geos_sys::*;
use std::convert::TryFrom;
use std::ptr::NonNull;
/// The `WKTWriter` type is used to generate `WKT` formatted output from [`Geometry`](crate::Geometry).
///
/// # Example
///
/// ```
/// use geos::{Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
/// let mut writer = WKTWriter::new()?;
///
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.5)");
/// # Ok::<(), geos::Error>(())
/// ```
pub struct WKTWriter {
ptr: NonNull<GEOSWKTWriter>,
}
impl WKTWriter {
/// Creates a new `WKTWriter` instance.
///
/// # Example
///
/// ```
/// use geos::{Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
/// let mut writer = WKTWriter::new()?;
///
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.5)");
/// # Ok::<(), geos::Error>(())
/// ```
#[cfg(not(all(feature = "tests", not(feature = "v3_12_0"))))]
pub fn new() -> GResult<Self> {
with_context(|ctx| unsafe {
let ptr = nullcheck!(GEOSWKTWriter_create_r(ctx.as_raw()))?;
Ok(Self { ptr })
})
}
#[cfg(all(feature = "tests", not(feature = "v3_12_0")))]
pub fn new() -> GResult<WKTWriter> {
with_context(|ctx| unsafe {
let ptr = nullcheck!(GEOSWKTWriter_create_r(ctx.as_raw()))?;
GEOSWKTWriter_setOld3D_r(ctx.as_raw(), ptr.as_ptr(), false.into());
GEOSWKTWriter_setTrim_r(ctx.as_raw(), ptr.as_ptr(), true.into());
GEOSWKTWriter_setOutputDimension_r(ctx.as_raw(), ptr.as_ptr(), 3);
Ok(WKTWriter { ptr })
})
}
/// Writes out the given `geometry` as WKT format.
///
/// # Example
///
/// ```
/// use geos::{Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
/// let mut writer = WKTWriter::new()?;
///
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.5)");
/// # Ok::<(), geos::Error>(())
/// ```
pub fn write<G: Geom>(&mut self, geometry: &G) -> GResult<String> {
with_context(|ctx| unsafe {
let ptr = nullcheck!(GEOSWKTWriter_write_r(
ctx.as_raw(),
self.as_raw_mut(),
geometry.as_raw()
))?;
managed_string(ptr, ctx)
})
}
/// Sets the `precision` to be used when calling [`WKTWriter::write`]. Often, what users
/// actually want is the [`WKTWriter::set_trim`] method instead.
///
/// # Example
///
/// ```
/// use geos::{Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.543 2.567)")?;
/// let mut writer = WKTWriter::new()?;
///
/// writer.set_rounding_precision(2);
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.54 2.57)");
///
/// writer.set_rounding_precision(1);
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.6)");
/// # Ok::<(), geos::Error>(())
/// ```
#[cfg(not(all(doctest, feature = "tests", not(feature = "v3_10_0"))))]
pub fn set_rounding_precision(&mut self, precision: u32) {
with_context(|ctx| unsafe {
GEOSWKTWriter_setRoundingPrecision_r(ctx.as_raw(), self.as_raw_mut(), precision as _);
});
}
/// Sets the number of dimensions to be used when calling [`WKTWriter::write`]. By default, it
/// is 2.
///
/// # Example
///
/// ```
/// use geos::{CoordDimensions, Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (1.1 2.2 3.3)")?;
/// let mut writer = WKTWriter::new()?;
/// writer.set_trim(true);
///
/// writer.set_output_dimension(CoordDimensions::TwoD);
/// assert_eq!(writer.write(&point_geom)?, "POINT (1.1 2.2)");
///
/// writer.set_output_dimension(CoordDimensions::ThreeD);
/// assert_eq!(writer.write(&point_geom)?, "POINT Z (1.1 2.2 3.3)");
/// # Ok::<(), geos::Error>(())
/// ```
pub fn set_output_dimension(&mut self, dimension: CoordDimensions) {
with_context(|ctx| unsafe {
GEOSWKTWriter_setOutputDimension_r(ctx.as_raw(), self.as_raw_mut(), dimension.into());
});
}
/// Returns the number of dimensions to be used when calling [`WKTWriter::write`]. By default,
/// it is 2.
///
/// # Example
///
/// ```
/// use geos::{CoordDimensions, WKTWriter};
///
/// let mut writer = WKTWriter::new()?;
///
/// writer.set_output_dimension(CoordDimensions::TwoD);
/// assert_eq!(writer.get_out_dimension()?, CoordDimensions::TwoD);
///
/// writer.set_output_dimension(CoordDimensions::ThreeD);
/// assert_eq!(writer.get_out_dimension()?, CoordDimensions::ThreeD);
/// # Ok::<(), geos::Error>(())
/// ```
pub fn get_out_dimension(&self) -> GResult<CoordDimensions> {
with_context(|ctx| unsafe {
let out = errcheck!(
-1,
GEOSWKTWriter_getOutputDimension_r(ctx.as_raw(), self.as_raw_mut_override())
)?;
CoordDimensions::try_from(out)
})
}
/// Enables/disables trimming of unnecessary decimals.
///
/// # Example
///
/// ```
/// use geos::{Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
/// let mut writer = WKTWriter::new()?;
///
/// writer.set_trim(false);
/// assert_eq!(
/// writer.write(&point_geom)?,
/// "POINT (2.5000000000000000 2.5000000000000000)"
/// );
///
/// writer.set_trim(true);
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.5)");
/// # Ok::<(), geos::Error>(())
/// ```
pub fn set_trim(&mut self, trim: bool) {
with_context(|ctx| unsafe {
GEOSWKTWriter_setTrim_r(ctx.as_raw(), self.as_raw_mut(), trim.into());
});
}
/// Enables/disables old 3D/4D WKT style generation.
///
/// # Example
///
/// ```
/// use geos::{CoordDimensions, Geometry, WKTWriter};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5 2.5)")?;
/// let mut writer = WKTWriter::new()?;
///
/// writer.set_output_dimension(CoordDimensions::ThreeD);
/// writer.set_trim(true);
///
/// assert_eq!(writer.write(&point_geom)?, "POINT Z (2.5 2.5 2.5)");
///
/// writer.set_old_3D(true);
/// assert_eq!(writer.write(&point_geom)?, "POINT (2.5 2.5 2.5)");
/// # Ok::<(), geos::Error>(())
/// ```
#[allow(non_snake_case)]
pub fn set_old_3D(&mut self, use_old_3D: bool) {
with_context(|ctx| unsafe {
GEOSWKTWriter_setOld3D_r(ctx.as_raw(), self.as_raw_mut(), use_old_3D.into());
});
}
}
unsafe impl Send for WKTWriter {}
unsafe impl Sync for WKTWriter {}
impl Drop for WKTWriter {
fn drop(&mut self) {
with_context(|ctx| unsafe { GEOSWKTWriter_destroy_r(ctx.as_raw(), self.as_raw_mut()) });
}
}
as_raw_mut_impl!(WKTWriter, GEOSWKTWriter);