Struct Ring 

pub struct Ring<P: PointTrait, const CLOCKWISE: bool = true, const CLOSED: bool = true>(pub Vec<P>);

Default Ring — a Vec<P> newtype carrying closure and traversal direction as const generics.

Mirrors boost::geometry::model::ring<Point, ClockWise, Closed> from boost/geometry/geometries/ring.hpp:56-99. The defaults (CLOCKWISE = true, CLOSED = true) match Boost’s defaults (boost/geometry/geometries/ring.hpp:59).

Tuple Fields

0: Vec<P>

Implementations

impl<P: PointTrait, const CW: bool, const CL: bool> Ring<P, CW, CL>

pub const fn new() -> Self

Construct an empty ring.

Mirrors the default ring() constructor at boost/geometry/geometries/ring.hpp:71-73.

pub const fn from_vec(v: Vec<P>) -> Self

Wrap an existing Vec<P> as a ring without copying.

Rust analogue of the iterator-range ring(Iterator, Iterator) constructor at boost/geometry/geometries/ring.hpp:76-79; the Vec is moved in rather than copied element-by-element.

pub fn push(&mut self, p: P)

Append a point to the back of the ring.

Plays the role of std::vector::push_back on the inherited base_type in boost/geometry/geometries/ring.hpp:63-67.

Trait Implementations

impl<P: Clone + PointTrait, const CLOCKWISE: bool, const CLOSED: bool> Clone for Ring<P, CLOCKWISE, CLOSED>

fn clone(&self) -> Ring<P, CLOCKWISE, CLOSED>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug + PointTrait, const CLOCKWISE: bool, const CLOSED: bool> Debug for Ring<P, CLOCKWISE, CLOSED>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: PointTrait, const CW: bool, const CL: bool> Default for Ring<P, CW, CL>

fn default() -> Self

Returns the “default value” for a type.

impl<P: PointTrait, const CW: bool, const CL: bool> Geometry for Ring<P, CW, CL>

Tag this concrete type as a Ring. Mirrors the traits::tag<model::ring<...>> specialisation at boost/geometry/geometries/ring.hpp:108-118.

type Kind = RingTag

One of the *Tag types from geometry_tag.

type Point = P

The point type this geometry is built from. For a value modelling Point, this is Self.

impl<P: PartialEq + PointTrait, const CLOCKWISE: bool, const CLOSED: bool> PartialEq for Ring<P, CLOCKWISE, CLOSED>

fn eq(&self, other: &Ring<P, CLOCKWISE, CLOSED>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<A, const D: usize, OldCs, T, Cs, const CW: bool, const CL: bool> RebindGeometry<T, Cs> for Ring<Point<A, D, OldCs>, CW, CL>

where A: CoordinateScalar, OldCs: CoordinateSystem, T: CoordinateScalar, Cs: CoordinateSystem,

type Output = Ring<Point<T, D, Cs>, CW, CL>

The corresponding rebound stock model.

impl<P: PointTrait, const CW: bool, const CL: bool> Ring for Ring<P, CW, CL>

Wire the Ring concept up. The points() iterator hands back self.0.iter() — slice::Iter is already ExactSizeIterator + Clone. The closure() and point_order() methods read the two const-generic booleans, mirroring the four traits::point_order / traits::closure specialisations at boost/geometry/geometries/ring.hpp:121-168 that dispatch on the same two template parameters.

fn points(&self) -> impl ExactSizeIterator<Item = &P> + Clone

The points of this ring, in declared order.

fn closure(&self) -> Closure

Whether this ring’s last point repeats its first.

fn point_order(&self) -> PointOrder

The traversal direction of this ring’s boundary.

impl<P: PartialEq + PointTrait, const CLOCKWISE: bool, const CLOSED: bool> StructuralPartialEq for Ring<P, CLOCKWISE, CLOSED>