Struct substrate::geometry::edge::Edge

pub struct Edge { /* private fields */ }

An edge of a rectangle.

Implementations

impl Edge

pub fn new(side: Side, coord: i64, span: Span) -> Edge

Create a new edge.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));

pub fn side(&self) -> Side

The side (of a rectangle) to which this edge corresponds.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.side(), Side::Left);

pub fn coord(&self) -> i64

The coordinate of the edge.

For left/right edges, this will be the x coordinate of the edge. For top/bottom edges, this will be the y coordinate of the edge.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.coord(), 20);

pub fn span(&self) -> Span

The span of the edge.

For left/right edges, this will be the range of y-coordinates encompassed by the edge. For top/bottom edges, this will be the range of x-coordinates encompassed by the edge.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.span(), Span::new(40, 100));

pub fn with_span(&self, span: Span) -> Edge

Returns an Edge with the same properties as the provided Edge but with a new span.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.span(), Span::new(40, 100));
let edge_new = edge.with_span(Span::new(20, 100));
assert_eq!(edge_new.span(), Span::new(20, 100));

pub fn norm_dir(&self) -> Dir

The direction perpendicular to the edge.

For left/right edges, this will be Dir::Horiz. For top/bottom edges, this will be Dir::Vert.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.norm_dir(), Dir::Horiz);
let edge = Edge::new(Side::Right, 20, Span::new(40, 100));
assert_eq!(edge.norm_dir(), Dir::Horiz);
let edge = Edge::new(Side::Top, 20, Span::new(40, 100));
assert_eq!(edge.norm_dir(), Dir::Vert);
let edge = Edge::new(Side::Bot, 20, Span::new(40, 100));
assert_eq!(edge.norm_dir(), Dir::Vert);

pub fn edge_dir(&self) -> Dir

The direction parallel to the edge.

For left/right edges, this will be Dir::Vert. For top/bottom edges, this will be Dir::Horiz.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.edge_dir(), Dir::Vert);
let edge = Edge::new(Side::Right, 20, Span::new(40, 100));
assert_eq!(edge.edge_dir(), Dir::Vert);
let edge = Edge::new(Side::Top, 20, Span::new(40, 100));
assert_eq!(edge.edge_dir(), Dir::Horiz);
let edge = Edge::new(Side::Bot, 20, Span::new(40, 100));
assert_eq!(edge.edge_dir(), Dir::Horiz);

pub fn offset(&self, offset: i64) -> Edge

Returns a new Edge offset some amount away from this edge.

Left edges will be offset to the left; right edges will be offset to the right. Top edges will be offset upwards; bottom edges will be offset downwards.

Example

let edge = Edge::new(Side::Left, 20, Span::new(40, 100));
assert_eq!(edge.offset(10), Edge::new(Side::Left, 10, Span::new(40, 100)));

let edge = Edge::new(Side::Top, 20, Span::new(40, 100));
assert_eq!(edge.offset(10), Edge::new(Side::Top, 30, Span::new(40, 100)));

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Edge

fn deserialize<__D>( __deserializer: __D ) -> Result<Edge, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Edge

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Edge

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Edge

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Edge

impl Eq for Edge

impl StructuralPartialEq for Edge