Struct bufkit_data::Site

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

Description of a site with a sounding.

Fields

id: String

Site id, usually a 3 or 4 letter identifier (e.g. kord katl ksea).

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.

Implementations

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 Debug for Site

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

Formats the value using the given formatter.

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: &Rhs) -> bool

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

impl StructuralPartialEq for Site