# [−][src]Struct geos::CoordSeq

`pub struct CoordSeq<'a> { /* fields omitted */ }`

`CoordSeq` represents a list of coordinates inside a `Geometry`.

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::OneD)
.expect("failed to create CoordSeq");
coords.set_x(0, 10.);
assert_eq!(coords.get_x(0), Ok(10.));```

## Methods

### `impl<'a> CoordSeq<'a>`[src]

#### `pub fn new(size: u32, dims: CoordDimensions) -> GResult<CoordSeq<'a>>`[src]

Creates a new `CoordSeq`.

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coord_seq = CoordSeq::new(2, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");

// Then you fill the positions of your `coord_seq`:
let positions: &[(f64, f64, f64)] = &[(0., 0., 0.), (1., 2., 1.)];
for (pos, (x, y, z)) in positions.into_iter().enumerate() {
coord_seq.set_x(pos, *x).expect("failed to set x...");
coord_seq.set_y(pos, *y).expect("failed to set y...");
coord_seq.set_z(pos, *z).expect("failed to set z...");
}
assert_eq!(coord_seq.get_z(1), Ok(1.));

// An example with 2 dimensions (and 3 lines) as well:
let mut coord_seq2 = CoordSeq::new(3, CoordDimensions::TwoD)
.expect("failed to create CoordSeq");
let positions2: &[(f64, f64)] = &[(0., 0.), (1., 2.), (14., 5.)];
for (pos, (x, y)) in positions2.into_iter().enumerate() {
coord_seq2.set_x(pos, *x).expect("failed to set x...");
coord_seq2.set_y(pos, *y).expect("failed to set y...");
}
assert_eq!(coord_seq2.get_x(1), Ok(1.));```

#### `pub fn new_from_vec<T: AsRef<[f64]>>(data: &[T]) -> GResult<CoordSeq<'a>>`[src]

Creates a new `CoordSeq`.

# Example

```use geos::CoordSeq;

let coords = CoordSeq::new_from_vec(&[&[0., 1.], &[2., 3.]])
.expect("failed to create CoordSeq");
assert_eq!(coords.get_y(1), Ok(3.));

// Doing it from a Vec<Vec<f64>>.
let positions = vec![vec![0., 1.], vec![2., 3.]];
let s_positions = positions.iter().map(|x| x.as_slice()).collect::<Vec<_>>();
let coords = CoordSeq::new_from_vec(&s_positions)
.expect("failed to create CoordSeq");
assert_eq!(coords.get_y(1), Ok(3.));

// All vectors don't have the same length, this is an error!
assert!(CoordSeq::new_from_vec(&[vec![0., 1.], vec![3.]]).is_err());

// An empty vector is an error as well since we can't figure out its dimensions!
let x: &[f64] = &[];
assert!(CoordSeq::new_from_vec(&[x]).is_err());```

#### `pub fn set_x(&mut self, line: usize, val: f64) -> GResult<()>`[src]

Sets the X position value at the given `line`.

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::OneD)
.expect("failed to create CoordSeq");
coords.set_x(0, 10.);
assert_eq!(coords.get_x(0), Ok(10.));```

#### `pub fn set_y(&mut self, line: usize, val: f64) -> GResult<()>`[src]

Sets the Y position value at the given `line`.

Note: your `CoordSeq` object must have at least two dimensions!

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::TwoD)
.expect("failed to create CoordSeq");
coords.set_y(0, 10.);
assert_eq!(coords.get_y(0), Ok(10.));```

#### `pub fn set_z(&mut self, line: usize, val: f64) -> GResult<()>`[src]

Sets the Z position value at the given `line`.

Note: your `CoordSeq` object must have three dimensions!

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
coords.set_z(0, 10.);
assert_eq!(coords.get_z(0), Ok(10.));```

#### `pub fn set_ordinate(    &mut self,     line: usize,     ordinate: Ordinate,     val: f64) -> GResult<()>`[src]

Sets the value at the given `ordinate` (aka position).

Note: your `CoordSeq` object must have enough dimensions to set at the given `ordinate`!

# Example

```use geos::{CoordDimensions, CoordSeq, Ordinate};

let mut coords = CoordSeq::new(1, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
coords.set_ordinate(0, Ordinate::Z, 10.);
assert_eq!(coords.get_z(0), Ok(10.));
assert_eq!(coords.get_ordinate(0, Ordinate::Z), 10.);```

#### `pub fn get_x(&self, line: usize) -> GResult<f64>`[src]

Gets the X position value at the given `line`.

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::OneD)
.expect("failed to create CoordSeq");
coords.set_x(0, 10.);
assert_eq!(coords.get_x(0), Ok(10.));```

#### `pub fn get_y(&self, line: usize) -> GResult<f64>`[src]

Gets the Y position value at the given `line`.

Note: your `CoordSeq` object must have at least two dimensions!

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::TwoD)
.expect("failed to create CoordSeq");
coords.set_y(0, 10.);
assert_eq!(coords.get_y(0), Ok(10.));```

#### `pub fn get_z(&self, line: usize) -> GResult<f64>`[src]

Gets the Z position value at the given `line`.

Note: your `CoordSeq` object must have three dimensions!

# Example

```use geos::{CoordDimensions, CoordSeq};

let mut coords = CoordSeq::new(1, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
coords.set_z(0, 10.);
assert_eq!(coords.get_z(0), Ok(10.));```

#### `pub fn get_ordinate(&self, line: usize, ordinate: Ordinate) -> f64`[src]

Gets the value at the given `ordinate` (aka position).

Note: your `CoordSeq` object must have enough dimensions to access the given `ordinate`!

# Example

```use geos::{CoordDimensions, CoordSeq, Ordinate};

let mut coords = CoordSeq::new(1, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
coords.set_ordinate(0, Ordinate::Z, 10.);
assert_eq!(coords.get_z(0), Ok(10.));
assert_eq!(coords.get_ordinate(0, Ordinate::Z), 10.);```

#### `pub fn size(&self) -> GResult<usize>`[src]

Returns the number of lines of the `CoordSeq` object.

# Example

```use geos::{CoordDimensions, CoordSeq};

let coords = CoordSeq::new(2, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
assert_eq!(coords.size(), Ok(2));

let coords = CoordSeq::new_from_vec(&[&[1f64], &[2.], &[3.], &[4.]])
.expect("failed to create CoordSeq");
assert_eq!(coords.size(), Ok(4));```

#### `pub fn number_of_lines(&self) -> GResult<usize>`[src]

Returns the number of lines of the `CoordSeq` object.

Note: This is an alias to the `size` method.

# Example

```use geos::{CoordDimensions, CoordSeq};

let coords = CoordSeq::new(2, CoordDimensions::ThreeD)
.expect("failed to create CoordSeq");
assert_eq!(coords.number_of_lines(), Ok(2));

let coords = CoordSeq::new_from_vec(&[&[1f64], &[2.], &[3.], &[4.]])
.expect("failed to create CoordSeq");
assert_eq!(coords.number_of_lines(), Ok(4));```

#### `pub fn dimensions(&self) -> GResult<CoordDimensions>`[src]

Returns the number of dimensions of the `CoordSeq` object.

# Example

```use geos::{CoordDimensions, CoordSeq};

let coords = CoordSeq::new(2, CoordDimensions::OneD)
.expect("failed to create CoordSeq");
assert_eq!(coords.dimensions(), Ok(CoordDimensions::OneD));

let coords = CoordSeq::new_from_vec(&[&[1., 2.], &[3. ,4.]])
.expect("failed to create CoordSeq");
assert_eq!(coords.dimensions(), Ok(CoordDimensions::TwoD));```

#### `pub fn is_ccw(&self) -> GResult<bool>`[src]

Returns `true` if the geometry has a counter-clockwise orientation.

Available using the `v3_7_0` feature.

#### `pub fn create_point(self) -> GResult<Geometry<'a>>`[src]

Creates a point geometry.

# Example

```use geos::{CoordDimensions, CoordSeq, Geometry};

let coords = CoordSeq::new_from_vec(&[&[1., 2.]])
.expect("failed to create CoordSeq");

let geom = Geometry::create_point(coords).expect("Failed to create point");

assert_eq!(geom.to_wkt().unwrap(), "POINT (1.0000000000000000 2.0000000000000000)");```

#### `pub fn create_line_string(self) -> GResult<Geometry<'a>>`[src]

Creates a line string geometry.

# Example

```use geos::{CoordDimensions, CoordSeq, Geometry};

let coords = CoordSeq::new_from_vec(&[&[1., 2.], &[3., 4.]])
.expect("failed to create CoordSeq");

let geom = Geometry::create_line_string(coords).expect("Failed to create line string");

assert_eq!(geom.to_wkt().unwrap(),
"LINESTRING (1.0000000000000000 2.0000000000000000, \
3.0000000000000000 4.0000000000000000)");```

#### `pub fn create_linear_ring(self) -> GResult<Geometry<'a>>`[src]

Creates a linear ring geometry.

## Trait Implementations

### `impl<'a> ContextInteractions<'a> for CoordSeq<'a>`[src]

#### `fn set_context_handle(&mut self, context: ContextHandle<'a>)`[src]

Set the context handle to the `CoordSeq`.

```use geos::{ContextInteractions, CoordDimensions, CoordSeq, ContextHandle};

let context_handle = ContextHandle::init().expect("invalid init");
context_handle.set_notice_message_handler(Some(Box::new(|s| println!("new message: {}", s))));
let mut coord_seq = CoordSeq::new(2, CoordDimensions::TwoD).expect("failed to create CoordSeq");
coord_seq.set_context_handle(context_handle);```

#### `fn get_context_handle(&self) -> &ContextHandle<'a>`[src]

Get the context handle of the `CoordSeq`.

```use geos::{ContextInteractions, CoordDimensions, CoordSeq};

let coord_seq = CoordSeq::new(2, CoordDimensions::TwoD).expect("failed to create CoordSeq");
let context = coord_seq.get_context_handle();
context.set_notice_message_handler(Some(Box::new(|s| println!("new message: {}", s))));```

#### `fn get_last_error(&self) -> Option<String>`[src]

Gets the last error (if any) from the `ContextHandle` held by this object. Read more

#### `fn get_last_notification(&self) -> Option<String>`[src]

Gets the last notification (if any) from the `ContextHandle` held by this object. Read more

### `impl<'a> Clone for CoordSeq<'a>`[src]

#### `fn clone(&self) -> CoordSeq<'a>`[src]

Also pass the context to the newly created `CoordSeq`.

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

## Blanket Implementations

### `impl<T> ToOwned for T where    T: Clone, `[src]

#### `type Owned = T`

The resulting type after obtaining ownership.

### `impl<T, U> TryFrom<U> for T where    U: Into<T>, `[src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

### `impl<T, U> TryInto<U> for T where    U: TryFrom<T>, `[src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.