Struct Stat 

pub struct Stat {
    pub time: Option<String>,
    pub latitude_deg: Option<f64>,
    pub longitude_deg: Option<f64>,
    pub altitude_m: Option<i32>,
    pub received: u32,
    pub received_ok: u32,
    pub forwarded: u32,
    pub acknowledged_percent: f64,
    pub downlinks: u32,
    pub transmitted: u32,
}

The gateway’s own status report.

Examples

use pamoja_gateway::udp::Stat;

let report = Stat::new().with_counts(2, 2, 2).with_downlinks(2, 2);
assert!(report.to_json().contains("\"rxfw\":2"));

Fields

time: Option<String>

The gateway’s clock, as time::expanded writes it.

latitude_deg: Option<f64>

Its latitude in degrees, north positive.

longitude_deg: Option<f64>

Its longitude in degrees, east positive.

altitude_m: Option<i32>

Its altitude in meters.

received: u32

How many packets its radio received.

received_ok: u32

How many of those had a good CRC.

forwarded: u32

How many it forwarded.

acknowledged_percent: f64

What share of its datagrams were acknowledged, as a percentage.

downlinks: u32

How many downlink datagrams it received.

transmitted: u32

How many packets it transmitted.

Implementations

impl Stat

pub fn new() -> Stat

An empty report, which is what a gateway with nothing yet to say sends.

Returns

The report.

pub fn at(self, seconds_since_epoch: u64) -> Stat

Returns it with the gateway’s clock.

Arguments

• seconds_since_epoch - the time in seconds since 1970-01-01 UTC.

Returns

The report.

pub fn at_position( self, latitude_deg: f64, longitude_deg: f64, altitude_m: i32, ) -> Stat

Returns it with the gateway’s position.

Arguments

• latitude_deg - degrees north.
• longitude_deg - degrees east.
• altitude_m - meters above sea level.

Returns

The report.

pub fn with_counts( self, received: u32, received_ok: u32, forwarded: u32, ) -> Stat

Returns it with what the radio heard.

Arguments

• received - packets received.
• received_ok - those with a good CRC.
• forwarded - those forwarded to the server.

Returns

The report.

pub fn with_downlinks(self, downlinks: u32, transmitted: u32) -> Stat

Returns it with what the downlink side did.

Arguments

• downlinks - datagrams received from the server.
• transmitted - packets transmitted.

Returns

The report.

pub fn with_acknowledged_percent(self, percent: f64) -> Stat

Returns it with the share of its datagrams the server acknowledged.

Arguments

• percent - the percentage.

Returns

The report.

pub fn to_json(&self) -> String

Writes the object as the protocol carries it.

Returns

The JSON text of the stat object.

Trait Implementations

impl Clone for Stat

fn clone(&self) -> Stat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stat

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

Formats the value using the given formatter.

impl Default for Stat

fn default() -> Stat

Returns the “default value” for a type.

impl From<Stat> for Uplink

fn from(status: Stat) -> Uplink

Converts to this type from the input type.

impl PartialEq for Stat

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