Struct FormatOptions 

pub struct FormatOptions { /* private fields */ }

The default format is FormatKind::Decimal (plain decimal degrees). When you use the alternate flag ({:#}) the default DMS variant is used.

Implementations

impl FormatOptions

pub const fn decimal() -> Self

Return a FormatOptions for decimal degrees with the default precision.

pub const fn dms() -> Self

Return a FormatOptions for degrees, minutes, seconds with the default precision.

pub const fn dms_signed() -> Self

Return a FormatOptions for signed degrees, minutes, seconds with the default precision.

pub const fn dms_labeled() -> Self

Return a FormatOptions for labeled degrees, minutes, seconds with the default precision.

pub const fn dms_bare() -> Self

Return a FormatOptions for bare degrees, minutes, seconds with the default precision.

pub const fn with_precision(self, precision: usize) -> Self

Override the number of fractional digits used when rendering.

Examples

use lat_long::{Angle, Latitude, fmt::{FormatOptions, Formatter}};

let lat = Latitude::new(48, 51, 29.6).unwrap();
let s = lat.to_formatted_string(&FormatOptions::decimal().with_precision(2));
assert_eq!(s, "48.86");

pub const fn with_default_precision(self) -> Self

Set the precision to the default value for the current FormatKind.

Decimal uses DEFAULT_DECIMAL_PRECISION; every DMS variant uses DEFAULT_DMS_PRECISION.

pub const fn with_labels(self, labels: (char, char)) -> Self

Set the (positive, negative) label pair used by FormatKind::DmsLabeled.

Prefer with_latitude_labels or with_longitude_labels for the standard N/S and E/W pairs.

pub const fn with_latitude_labels(self) -> Self

Convenience: set labels to the latitude pair ('N', 'S').

pub const fn with_longitude_labels(self) -> Self

Convenience: set labels to the longitude pair ('E', 'W').

pub const fn kind(&self) -> FormatKind

Returns the configured FormatKind.

pub const fn is_decimal(&self) -> bool

Returns true if this is a FormatKind::Decimal format.

pub const fn is_dms(&self) -> bool

Returns true if this is any DMS variant (signed, labeled, or bare).

pub const fn is_dms_signed(&self) -> bool

Returns true if this is the FormatKind::DmsSigned variant.

pub const fn is_dms_labeled(&self) -> bool

Returns true if this is the FormatKind::DmsLabeled variant.

pub const fn is_dms_bare(&self) -> bool

Returns true if this is the FormatKind::DmsBare variant.

pub const fn precision(&self) -> Option<usize>

Returns the configured precision, if any was set.

pub const fn labels(&self) -> Option<(char, char)>

Returns the configured (positive, negative) label pair, if any.

pub fn positive_label(&self) -> Option<char>

Returns just the label used for positive values, if labels are set.

pub fn negative_label(&self) -> Option<char>

Returns just the label used for negative values, if labels are set.

Trait Implementations

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatOptions

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

Formats the value using the given formatter.

impl Default for FormatOptions

fn default() -> FormatOptions

Returns the “default value” for a type.

impl From<FormatKind> for FormatOptions

fn from(kind: FormatKind) -> Self

Converts to this type from the input type.

impl Hash for FormatOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FormatOptions

fn eq(&self, other: &FormatOptions) -> 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 Copy for FormatOptions

impl Eq for FormatOptions

impl StructuralPartialEq for FormatOptions