Struct geod_types::Latitude

pub struct Latitude<A: Angle>(_);

The angle measured between the equatorial plane and the point along the meridian. .

Implementations

impl<A: Angle> Latitude<A>

pub fn north<T>(angle: T) -> Result<Self, A::NumErr> where
    T: TryInto<A, Error = A::NumErr>, 

Construct a northern latitude with some numeric information.

Errors

• cannot construct an angle from the given information (overflow of some kind)
• the constructed angle is more than the right angle. Valid latitude is in the range 0 <= lat <= 90 deg.

pub fn south<T>(angle: T) -> Result<Self, A::NumErr> where
    T: TryInto<A, Error = A::NumErr>, 

Construct a southern latitude with some numeric information.

Errors

• cannot construct an angle from the given information (overflow of some kind)
• the constructed angle is more than the right angle. Valid latitude is in the range 0 <= lat <= 90 deg.

pub fn equator() -> Self

The central latitude of the sphere equidistant from the poles

pub fn angle_from_equator(self) -> A

Angle between the latitude and the equator (absolute value of the latitude).

pub fn hemisphere(self) -> Option<Pole>

Which pole are closer to the given latitude

pub fn is_pole(self) -> bool

Is the given latitude belongs to a pole

Trait Implementations

impl<A: Angle> Add<A> for Latitude<A>

type Output = Result<Self, A::NumErr>

The resulting type after applying the + operator.

fn add(self, rhs: A) -> Self::Output

Represent the north movement

impl<A: Clone + Angle> Clone for Latitude<A>

fn clone(&self) -> Latitude<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Copy + Angle> Copy for Latitude<A>

impl<A: Debug + Angle> Debug for Latitude<A>

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

Formats the value using the given formatter.

impl<A: Angle> Default for Latitude<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: Angle> Display for Latitude<A> where
    A: Display, 

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

Formats the value using the given formatter.

impl<A: Eq + Angle> Eq for Latitude<A>

impl<A: Angle> FromStr for Latitude<A> where
    A::ParseErr: From<A::NumErr>, 

type Err = ParseCoordinateError<A::ParseErr>

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<A: Angle> Neg for Latitude<A>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<A: Ord + Angle> Ord for Latitude<A>

fn cmp(&self, other: &Latitude<A>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<A: PartialEq + Angle> PartialEq<Latitude<A>> for Latitude<A>

fn eq(&self, other: &Latitude<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Latitude<A>) -> bool

This method tests for !=.

impl<A: PartialOrd + Angle> PartialOrd<Latitude<A>> for Latitude<A>

fn partial_cmp(&self, other: &Latitude<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A: Angle> StructuralEq for Latitude<A>

impl<A: Angle> StructuralPartialEq for Latitude<A>

impl<A: Angle> Sub<A> for Latitude<A>

type Output = Result<Self, A::NumErr>

The resulting type after applying the - operator.

fn sub(self, rhs: A) -> Self::Output

Represent the south movement

impl<A: Angle> Sub<Latitude<A>> for Latitude<A>

type Output = Result<A, A::NumErr>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<A: Angle> TryFrom<[i16; 2]> for Latitude<A> where
    Self: TryFrom<[i16; 4], Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: [i16; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<[i16; 3]> for Latitude<A> where
    Self: TryFrom<[i16; 4], Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: [i16; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[i16; 4]> for Latitude<AccurateDegree>

type Error = <AccurateDegree as Angle>::NumErr

The type returned in the event of a conversion error.

fn try_from(value: [i16; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[i16; 4]> for Latitude<DecimalDegree>

type Error = <DecimalDegree as Angle>::NumErr

The type returned in the event of a conversion error.

fn try_from(value: [i16; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<(i8, u8, u8, u16)> for Latitude<A> where
    A: TryFrom<(u16, u8, u8, u16), Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: (i8, u8, u8, u16)) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<(i8, u8, u8)> for Latitude<A> where
    Self: TryFrom<(i8, u8, u8, u16), Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: (i8, u8, u8)) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<(i8, u8)> for Latitude<A> where
    Self: TryFrom<(i8, u8, u8, u16), Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: (i8, u8)) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<f64> for Latitude<A>

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Angle> TryFrom<i8> for Latitude<A> where
    Self: TryFrom<(i8, u8, u8, u16), Error = <A as Angle>::NumErr>, 

type Error = A::NumErr

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.