Struct OSGB

pub struct OSGB { /* private fields */ }

Type representing a valid British National Grid Reference. Can be instantiated either by parsing from a string or through a valid set of eastings and northings as coordinates.

Provides functionality to convert between strings and coordinates, as well as re-mapping to a new precision.

Implementations

impl OSGB

pub fn new( eastings: u32, northings: u32, precision: Precision, ) -> Result<Self, Error>

Creates a new grid reference from the given coordinates and precision.

Errors

Returns an error if the given coordinates are out of bounds.

Example

use gridish::{OSGB, Precision};

let gridref = OSGB::new(
    389_200,
    243_700,
    Precision::_100M
).unwrap();

assert_eq!(gridref.to_string(), "SO892437".to_string());

pub fn recalculate(&self, precision: Precision) -> Self

Recalculates the grid reference to a new precision.

Example

use gridish::{OSGB, Precision};

let gridref_100m: OSGB = "SO892437".parse().unwrap();
let gridref_10k = gridref_100m.recalculate(Precision::_10Km);

assert_eq!("SO84".to_string(), gridref_10k.to_string());

pub fn sw(&self) -> Point

Returns the point at the osgb’s ‘South West’ corner - its origin.

Example

use gridish::OSGB;
use geo_types::coord;

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.sw(), coord! {x: 389_200.0, y: 243_700.0 }.into());

pub fn nw(&self) -> Point

Returns the point at the osgb’s ‘North West’ corner.

Example

use gridish::OSGB;
use geo_types::coord;

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.nw(), coord! {x: 389_200.0, y: 243_800.0 }.into());

pub fn ne(&self) -> Point

Returns the point at the osgb’s ‘North East’ corner.

Example

use gridish::OSGB;
use geo_types::coord;

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.ne(), coord! {x: 389_300.0, y: 243_800.0 }.into());

pub fn se(&self) -> Point

Returns the point at the osgb’s ‘South East’ corner.

Example

use gridish::OSGB;
use geo_types::coord;

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.se(), coord! {x: 389_300.0, y: 243_700.0 }.into());

pub fn centre(&self) -> Point

Returns the point at the osgb’s centre.

Example

use gridish::OSGB;
use geo_types::coord;

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.centre(), coord! {x: 389_250.0, y: 243_750.0 }.into());

pub fn perimeter(&self) -> Polygon

Returns the osgb’s perimeter.

Example

use gridish::OSGB;
use geo_types::{LineString, Point, Polygon};

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(
    gridref.perimeter(),
    Polygon::new(
        LineString::from(
            vec![
                Point::new(389_200.0, 243_700.0),
                Point::new(389_200.0, 243_800.0),
                Point::new(389_300.0, 243_800.0),
                Point::new(389_300.0, 243_700.0)
            ]
        ),
        vec![]
    )
);

pub fn precision(&self) -> Precision

Returns the osgb’s precision.

Example

use gridish::{OSGB, Precision};

let gridref: OSGB = "SO892437".parse().unwrap();

assert_eq!(gridref.precision(), Precision::_100M);

Trait Implementations

impl Clone for OSGB

fn clone(&self) -> OSGB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OSGB

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

Formats the value using the given formatter.

impl Display for OSGB

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

Formats the value using the given formatter.

impl FromStr for OSGB

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for OSGB

fn eq(&self, other: &OSGB) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OSGB

impl StructuralPartialEq for OSGB