Struct RouteBriefingRequest 

#[non_exhaustive]
pub struct RouteBriefingRequest {
    pub waypoints: Vec<RouteWaypoint>,
    pub corridor_half_width_nm: f64,
    pub cruise_altitude_ft: Option<i32>,
    pub cruise_tas_kt: Option<f64>,
    pub departure_at: Option<DateTime<Utc>>,
    pub flight_rules: FlightRules,
    pub products: Vec<ProductKind>,
}

A briefing request for a route corridor.

Non-exhaustive: construct with RouteBriefingRequest::new and the with_* setters; future parameters (per-leg altitudes, alternates as structured points) are additive.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

waypoints: Vec<RouteWaypoint>

Ordered route waypoints, departure first, destination last.

corridor_half_width_nm: f64

Half-width of the corridor around the centerline, nautical miles.

cruise_altitude_ft: Option<i32>

Planned cruise altitude, feet MSL.

cruise_tas_kt: Option<f64>

Planned cruise true airspeed, knots.

departure_at: Option<DateTime<Utc>>

Intended departure time (ETD); anchors departure-relative sources.

flight_rules: FlightRules

Flight rules the route is flown under.

products: Vec<ProductKind>

Products to include; empty means the source’s default set.

Implementations

impl RouteBriefingRequest

pub fn new(waypoints: Vec<RouteWaypoint>, corridor_half_width_nm: f64) -> Self

A request over waypoints with a corridor_half_width_nm corridor, IFR, and source-default products.

pub fn with_cruise_altitude_ft(self, ft: Option<i32>) -> Self

Set the cruise altitude (feet MSL).

pub fn with_cruise_tas_kt(self, kt: Option<f64>) -> Self

Set the cruise true airspeed (knots).

pub fn with_departure_at(self, at: Option<DateTime<Utc>>) -> Self

Anchor the briefing to an intended departure time.

pub fn with_flight_rules(self, rules: FlightRules) -> Self

Set the flight rules.

pub fn with_products(self, products: Vec<ProductKind>) -> Self

Restrict to the given product kinds (empty = source default set).

pub fn total_distance_nm(&self) -> f64

Total great-circle length of the route, nautical miles.

pub fn idents(&self) -> Vec<&str>

The published identifiers along the route, in order, skipping bare lat/lon points.

pub fn segment_bboxes(&self, max_segment_nm: f64) -> Vec<Area>

Cover the corridor with axis-aligned bounding boxes, each spanning at most max_segment_nm of route, padded by the corridor half-width. An area-only provider (AWC) issues one request per box — fewer, larger boxes near the cap; one box for a short route.

Trait Implementations

impl Clone for RouteBriefingRequest

fn clone(&self) -> RouteBriefingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteBriefingRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RouteBriefingRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RouteBriefingRequest

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RouteBriefingRequest