Enum cursive_core::direction::Direction

pub enum Direction {
    Abs(Absolute),
    Rel(Relative),
}

Represents a direction, either absolute or orientation-dependent.

• Absolute directions are Up, Down, Left, and Right.
• Relative directions are Front and Back.

Variants

Abs(Absolute)

An absolute direction.

Rel(Relative)

A direction relative to the current orientation.

Implementations

impl Direction

pub const fn relative(self, orientation: Orientation) -> Option<Relative>

Returns the relative direction for the given orientation.

Some combination have no corresponding relative position. For example, Direction::Abs(Up) means nothing for Orientation::Horizontal.

pub const fn absolute(self, orientation: Orientation) -> Absolute

Returns the absolute direction in the given orientation.

pub const fn opposite(self) -> Self

Returns the direction opposite self.

pub const fn back() -> Self

Shortcut to create Direction::Rel(Relative::Back)

pub const fn front() -> Self

Shortcut to create Direction::Rel(Relative::Front)

pub const fn left() -> Self

Shortcut to create Direction::Abs(Absolute::Left)

pub const fn right() -> Self

Shortcut to create Direction::Abs(Absolute::Right)

pub const fn up() -> Self

Shortcut to create Direction::Abs(Absolute::Up)

pub const fn down() -> Self

Shortcut to create Direction::Abs(Absolute::Down)

pub const fn none() -> Self

Shortcut to create Direction::Abs(Absolute::None)

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl Hash for Direction

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

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 Direction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction