Struct DiveSegment 

pub struct DiveSegment { /* private fields */ }

The atomic unit of a dive. Every dive can be represented by a list of DiveSegments.

Implementations

impl DiveSegment

pub fn new( segment_type: SegmentType, start_depth: usize, end_depth: usize, time: Duration, ascent_rate: isize, descent_rate: isize, ) -> Result<Self, DiveSegmentError>

Returns a new DiveSegment with the given parameters.

Arguments

• segment_type - Type of this segment. See SegmentType.
• start_depth- Depth at the beginning of the segment.
• end_depth - Depth at the end of the segment
• time - Duration of the segment.
• ascent_rate - Ascent rate of the segment (measured in m min^-1)
• descent_rate - Descent rate of the segment (measured in m min^-1)

Errors

This function will return a DiveSegmentError if any of the following are true:

• segment-type is AscDesc but start and end depths match.
• segment-type is not AscDesc but start and end depths do not match.

pub fn segment_type(&self) -> SegmentType

Returns the type of the segment.

pub fn start_depth(&self) -> usize

Returns the start depth of the segment.

pub fn end_depth(&self) -> usize

Returns the end depth of the segment.

pub fn time(&self) -> &Duration

Returns the duration of the segment.

pub fn ascent_rate(&self) -> isize

Returns the ascent rate of the segment.

pub fn descent_rate(&self) -> isize

Returns the descent rate of the segment.

pub fn gas_consumed(&self, sac_rate: usize, metres_per_bar: f64) -> usize

Returns the quantity of gas a diver would consume in the segment.

Arguments

• sac_rate - Surface Air Consumption (SAC) rate (measured in bar min^-1).
• metres_per_bar - Depth of water required to induce 1 bar of pressure.

Trait Implementations

impl Clone for DiveSegment

fn clone(&self) -> DiveSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiveSegment

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

Formats the value using the given formatter.

impl Copy for DiveSegment