geos 11.1.1

Rust bindings for GEOS C API
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

use crate::context_handle::with_context;
use crate::functions::*;
use crate::traits::as_raw_mut_impl;
#[cfg(feature = "v3_14_0")]
use crate::CoordDimensions;
use crate::{AsRaw, AsRawMut, GResult, Geom};
use geos_sys::*;
use std::ptr::NonNull;

/// The `GeoJSONWriter` type is used to generate `GeoJSON` formatted output from [`Geometry`](crate::Geometry).
///
/// # Example
///
/// ```
/// use geos::{GeoJSONWriter, Geometry};
///
/// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
/// let mut writer = GeoJSONWriter::new()?;
///
/// assert_eq!(
///     writer.write(&point_geom)?,
///     r#"{"type":"Point","coordinates":[2.5,2.5]}"#
/// );
/// # Ok::<(), geos::Error>(())
/// ```
pub struct GeoJSONWriter {
    ptr: NonNull<GEOSGeoJSONWriter>,
}

impl GeoJSONWriter {
    /// Creates a new `GeoJSONWriter` instance.
    ///
    /// # Example
    ///
    /// ```
    /// use geos::{GeoJSONWriter, Geometry};
    ///
    /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
    /// let mut writer = GeoJSONWriter::new()?;
    ///
    /// assert_eq!(
    ///     writer.write(&point_geom)?,
    ///     r#"{"type":"Point","coordinates":[2.5,2.5]}"#
    /// );
    /// # Ok::<(), geos::Error>(())
    /// ```
    pub fn new() -> GResult<Self> {
        with_context(|ctx| unsafe {
            let ptr = nullcheck!(GEOSGeoJSONWriter_create_r(ctx.as_raw()))?;
            Ok(Self { ptr })
        })
    }

    /// Writes out the given `geometry` as `GeoJSON` format.
    ///
    /// # Example
    ///
    /// ```
    /// use geos::{GeoJSONWriter, Geometry};
    ///
    /// let point_geom = Geometry::new_from_wkt("POINT (2.5 2.5)")?;
    /// let mut writer = GeoJSONWriter::new()?;
    ///
    /// assert_eq!(
    ///     writer.write(&point_geom)?,
    ///     r#"{"type":"Point","coordinates":[2.5,2.5]}"#
    /// );
    /// # Ok::<(), geos::Error>(())
    /// ```
    pub fn write<G: Geom>(&mut self, geometry: &G) -> GResult<String> {
        self.write_formatted(geometry, -1)
    }

    pub fn write_formatted<G: Geom>(&mut self, geometry: &G, indent: i32) -> GResult<String> {
        with_context(|ctx| unsafe {
            let ptr = nullcheck!(GEOSGeoJSONWriter_writeGeometry_r(
                ctx.as_raw(),
                self.as_raw_mut(),
                geometry.as_raw(),
                indent,
            ))?;
            managed_string(ptr, ctx)
        })
    }

    /// Sets the number of dimensions to be used when calling [`GeoJSONWriter::write`]. By default, it
    /// is 3.
    ///
    /// # Example
    ///
    /// ```
    /// use geos::{CoordDimensions, GeoJSONWriter, Geometry};
    ///
    /// let point_geom = Geometry::new_from_wkt("POINT (1.1 2.2 3.3)")?;
    /// let mut writer = GeoJSONWriter::new()?;
    ///
    /// writer.set_output_dimension(CoordDimensions::TwoD);
    /// assert_eq!(
    ///     writer.write(&point_geom)?,
    ///     r#"{"type":"Point","coordinates":[1.1,2.2]}"#
    /// );
    ///
    /// writer.set_output_dimension(CoordDimensions::ThreeD);
    /// assert_eq!(
    ///     writer.write(&point_geom)?,
    ///     r#"{"type":"Point","coordinates":[1.1,2.2,3.3]}"#
    /// );
    /// # Ok::<(), geos::Error>(())
    /// ```
    #[cfg(feature = "v3_14_0")]
    pub fn set_output_dimension(&mut self, dimension: CoordDimensions) {
        with_context(|ctx| unsafe {
            GEOSGeoJSONWriter_setOutputDimension_r(
                ctx.as_raw(),
                self.as_raw_mut(),
                dimension.into(),
            );
        });
    }

    /// Returns the number of dimensions to be used when calling [`GeoJSONWriter::write`]. By default,
    /// it is 3.
    ///
    /// # Example
    ///
    /// ```
    /// use geos::{CoordDimensions, GeoJSONWriter};
    ///
    /// let mut writer = GeoJSONWriter::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>(())
    /// ```
    #[cfg(feature = "v3_14_0")]
    pub fn get_out_dimension(&self) -> GResult<CoordDimensions> {
        with_context(|ctx| unsafe {
            let out = errcheck!(
                -1,
                GEOSGeoJSONWriter_getOutputDimension_r(ctx.as_raw(), self.as_raw_mut_override())
            )?;
            CoordDimensions::try_from(out)
        })
    }
}

unsafe impl Send for GeoJSONWriter {}
unsafe impl Sync for GeoJSONWriter {}

impl Drop for GeoJSONWriter {
    fn drop(&mut self) {
        with_context(|ctx| unsafe { GEOSGeoJSONWriter_destroy_r(ctx.as_raw(), self.as_raw_mut()) });
    }
}

as_raw_mut_impl!(GeoJSONWriter, GEOSGeoJSONWriter);