Struct HandrailRequest 

pub struct HandrailRequest { /* private fields */ }

A request for the handrails along a flight or a run.

The rails are the rule’s selection (railings of a handrail type, say): sorted, deduplicated and without the subject. reach is how far outside the walking surface’s sides a rail may run and still be measured along it, above how far above the pitch line’s highest point its lowest point may lie (so the rail of a flight stacked above is not taken for this one’s), and extension how far beyond each end of the pitch line the rise of a rail’s top is measured, zero for none.

Implementations

impl HandrailRequest

pub fn try_new( subject: ObjectId, stretch: WalkingStretch, rails: impl IntoIterator<Item = ObjectId>, (reach, above): (f64, f64), extension: f64, ) -> Result<Self, WalkingSurfaceError>

The handrails along stretch of subject among rails. reach, above and extension must be finite and not negative.

pub fn subject(&self) -> &ObjectId

The flight or ramp the rails run along.

pub fn stretch(&self) -> WalkingStretch

Which stretch of it.

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

The objects that may be its handrails.

pub fn reach(&self) -> f64

How far outside the walking surface’s sides a rail is still measured.

pub fn above(&self) -> f64

How far above the pitch line’s highest point a rail’s lowest point may lie and still be measured.

pub fn extension(&self) -> f64

How far beyond each end of the pitch line a rail’s rise is measured.

Trait Implementations

impl Clone for HandrailRequest

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 HandrailRequest

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

Formats the value using the given formatter.

impl PartialEq for HandrailRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HandrailRequest