Struct Headroom 

pub struct Headroom { /* private fields */ }

The vertical clearance above an object’s walking surface.

The walking surface is the subject’s upward-facing faces no steeper than 45°: treads, ramp slopes and landings. The clearance is the least vertical distance from a point of it to an obstacle’s body directly above; None when no requested obstacle stands above it anywhere.

Implementations

impl Headroom

pub fn try_new( request: HeadroomRequest, clearance: Option<MeasuredInterval>, governing: Vec<ObjectId>, evidence: Evidence, ) -> Result<Self, WalkingSurfaceError>

The headroom answering request. governing names the obstacles whose clearance may be the least one: at least one when there is a clearance, none otherwise, every one requested. A clearance interval is never exact evidence.

pub fn request(&self) -> &HeadroomRequest

The request this answers.

pub fn clearance(&self) -> Option<MeasuredInterval>

The least vertical clearance, or None when nothing stands above.

pub fn governing(&self) -> &[ObjectId]

The obstacles whose clearance may be the least.

pub fn evidence(&self) -> &Evidence

Reviewable provenance of the measurement.

Trait Implementations

impl Clone for Headroom

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Headroom

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

Formats the value using the given formatter.

impl PartialEq for Headroom

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Headroom