1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use crate::directions::request::{
    Request,
    traffic_model::TrafficModel,
}; // use

impl<'a> Request<'a> {

    /// Specifies the assumptions to use when calculating time in traffic.
    ///
    /// ## Arguments
    ///
    /// * `traffic_model` ‧ Which traffic model the directions service should
    /// use when calculating the route and duration in traffic - _best guess_,
    /// _optimistic_, or _pessimistic_?
    ///
    /// ## Description
    ///
    /// Specifies the assumptions to use when calculating time in traffic. This
    /// setting affects the value returned in the `duration_in_traffic` field in
    /// the response, which contains the predicted time in traffic based on
    /// historical averages. The traffic_model parameter may only be specified
    /// for driving directions where the request includes a `departure_time`,
    /// and only if the request includes an API key or a Google Maps Platform
    /// Premium Plan client ID. The available values for this parameter are:
    ///
    /// * `TrafficModel::BestGuess` (default) indicates that the returned
    /// `duration_in_traffic` should be the best estimate of travel time given
    /// what is known about both historical traffic conditions and live traffic.
    /// Live traffic becomes more important the closer the departure_time is to
    /// now.
    ///
    /// * `TrafficModel::Pessimistic` indicates that the returned
    /// `duration_in_traffic` should be longer than the actual travel time on
    /// most days, though occasional days with particularly bad traffic
    /// conditions may exceed this value.
    ///
    /// * `TrafficModel::Optimistic` indicates that the returned
    /// `duration_in_traffic` should be shorter than the actual travel time on
    /// most days, though occasional days with particularly good traffic
    /// conditions may be faster than this value.
    ///
    /// The default value of `BestGuess` will give the most useful predictions
    /// for the vast majority of use cases. It is possible the `BestGuess`
    /// travel time prediction may be _shorter_ than `Optimistic`, or
    /// alternatively, _longer_ than `Pessimistic`, due to the way the
    /// `BestGuess` prediction model integrates live traffic information.
    ///
    /// ## Example:
    ///
    /// * Set traffic model to pessimistic:
    /// ```rust
    /// .with_traffic_model(TrafficModel::Pessimistic)
    /// ```

    pub fn with_traffic_model(&'a mut self, traffic_model: TrafficModel) -> &'a mut Request {
        self.traffic_model = Some(traffic_model);
        self
    } // fn

} // impl