Struct RouteReport 

pub struct RouteReport {
    pub uuid: String,
    pub name: Option<String>,
    pub distance_nm: f64,
    pub legs: Vec<LegReport>,
}

What a whole route came back with.

Fields

uuid: String

The route’s identity, so a report can be matched to what it is about.

name: Option<String>

Its name at the time of checking.

distance_nm: f64

Total distance, each leg measured the way it is drawn.

legs: Vec<LegReport>

One per leg, in the order they are sailed.

Implementations

impl RouteReport

pub fn worst(&self) -> Option<Severity>

The worst thing found anywhere on the route, if anything was.

pub fn is_clear(&self) -> bool

Whether the route can be sailed as planned: nothing unsafe and nothing the check could not answer.

pub fn findings_along_route(&self) -> Vec<(f64, usize, &Finding)>

Every finding with its distance from the start of the route rather than from the start of its leg, worst first at equal distances.

Trait Implementations

impl Clone for RouteReport

fn clone(&self) -> RouteReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteReport

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

Formats the value using the given formatter.

impl PartialEq for RouteReport

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