Enum Anchor 

pub enum Anchor {
    TopLeft,
    TopRight,
    BottomLeft,
    BottomRight,
    TopCenter,
    BottomCenter,
    LeftCenter,
    RightCenter,
}

A point on the edge or corner of a box, used to align a position to that box.

Size::at_anchor, Bounds::corner and Bounds::from_anchor_and_size take an anchor. Anchors don’t carry a size, so they name a location on any box.

Examples

use gpui::{Anchor, Bounds, Point, Size};
let bounds = Bounds {
    origin: Point { x: 0, y: 0 },
    size: Size { width: 10, height: 20 },
};
assert_eq!(bounds.corner(Anchor::TopRight), Point { x: 10, y: 0 });

Variants

TopLeft

The top left corner.

TopRight

The top right corner.

BottomLeft

The bottom left corner.

BottomRight

The bottom right corner.

TopCenter

The midpoint of the top edge.

BottomCenter

The midpoint of the bottom edge.

LeftCenter

The midpoint of the left edge.

RightCenter

The midpoint of the right edge.

Implementations

impl Anchor

pub fn opposite(self) -> Self

Returns the anchor on the opposite side of the box.

Corners map to the diagonally opposite corner, and each edge midpoint maps to the midpoint of the opposite edge.

Examples

assert_eq!(Anchor::TopLeft.opposite(), Anchor::BottomRight);
assert_eq!(Anchor::TopCenter.opposite(), Anchor::BottomCenter);

pub fn other_side_along(self, axis: Axis) -> Self

Reflects this anchor across the center of the box along axis.

Axis::Vertical swaps the top and bottom sides, and Axis::Horizontal swaps the left and right sides. An anchor on the center line of that axis stays where it is.

Examples

assert_eq!(Anchor::TopLeft.other_side_along(Axis::Horizontal), Anchor::TopRight);
assert_eq!(Anchor::TopLeft.other_side_along(Axis::Vertical), Anchor::BottomLeft);
assert_eq!(Anchor::TopCenter.other_side_along(Axis::Horizontal), Anchor::TopCenter);

pub fn is_center(&self) -> bool

Returns true for the midpoint of an edge, and false for a corner.

Examples

assert!(Anchor::LeftCenter.is_center());
assert!(!Anchor::BottomRight.is_center());

pub fn is_bottom(&self) -> bool

Returns whether the anchor is bottom-positioned.

Trait Implementations

impl Clone for Anchor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Anchor

impl Debug for Anchor

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

Formats the value using the given formatter.

impl Eq for Anchor

impl PartialEq for Anchor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Anchor