Struct bufkit_data::Site

pub struct Site {
    pub station_num: u32,
    pub id: Option<String>,
    pub name: Option<String>,
    pub notes: Option<String>,
    pub state: Option<StateProv>,
    pub auto_download: bool,
    pub time_zone: Option<FixedOffset>,
}

Description of a site with a sounding.

Fields

station_num: u32

Station number, this should be unique to the site. Site ids sometimes change around.

id: Option<String>

Site ID. This is usually a 3 or 4 letter ID. These change from time to time and are not always unique to a site. If you need an identifief unique to a location, use the station_num. Because these change, it is possible to orphan a site with a site id, hence the option.

name: Option<String>

A longer, more human readable name.

notes: Option<String>

Any relevant notes about the site.

state: Option<StateProv>

The state or providence where this location is located. This allows querying sites by what state or providence they are in.

auto_download: bool

For programs that download files, this allows marking some sites for automatic download without further specification.

time_zone: Option<FixedOffset>

Time zone information

Methods

impl Site

pub fn incomplete(&self) -> bool

Return true if there is any missing data. It ignores the notes field since this is only rarely used.

Trait Implementations

impl Clone for Site

fn clone(&self) -> Site

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Site

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

Formats the value using the given formatter.

impl Default for Site

fn default() -> Self

Returns the "default value" for a type.

impl Display for Site

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Site

impl Hash for Site

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Site> for Site

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

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

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

This method tests for !=.

impl StructuralEq for Site

impl StructuralPartialEq for Site