Struct FindOptions 

pub struct FindOptions {
    pub safety_contour_m: f64,
    pub port_xtd_nm: f64,
    pub starboard_xtd_nm: f64,
    pub margin_nm: Option<f64>,
    pub cell_nm: Option<f64>,
    pub avoid_restricted_areas: bool,
}

What a route is being planned for, and how far around the direct line to search.

Fields

safety_contour_m: f64

The vessel’s safety contour, in metres – the same setting enc_store::Vessel takes, and the same one the chart is drawn with.

port_xtd_nm: f64

How far the vessel may stray to port of any leg the route ends up with, in nautical miles.

starboard_xtd_nm: f64

The same to starboard.

margin_nm: Option<f64>

How far beyond the direct line between from and to the search is allowed to reach, in nautical miles. Some is tried exactly once, at the given value, and not escalated further. None auto-scales the margin from the direct distance and escalates it a few times before giving up if the search finds nothing (see margin_schedule).

cell_nm: Option<f64>

Lattice spacing, in nautical miles. None auto-scales it from the direct distance, so a long passage does not blow up the lattice size and a short one is not searched more coarsely than it needs.

avoid_restricted_areas: bool

Whether a restricted area (RESARE – a marine reserve, a firing range, or another area a mariner must stay out of, not merely be cautioned about) blocks the route outright rather than only being crossed and reported. Off by default, the same posture check_leg itself takes: most restricted areas restrict anchoring or require a licence rather than prohibiting transit, and only the mariner planning the route knows which applies.

Trait Implementations

impl Clone for FindOptions

fn clone(&self) -> FindOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FindOptions

impl Debug for FindOptions

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

Formats the value using the given formatter.

impl PartialEq for FindOptions

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