Enum Direction 

#[repr(u8)]
pub enum Direction {
    Down = 0,
    Up = 1,
    North = 2,
    South = 3,
    West = 4,
    East = 5,
}

A cardinal direction in 3D space.

Values 0–5 map to Down, Up, North, South, West, East and are used directly as wire IDs in many packets.

Variants

Down = 0

Negative Y.

Up = 1

Positive Y.

North = 2

Negative Z.

South = 3

Positive Z.

West = 4

Negative X.

East = 5

Positive X.

Implementations

impl Direction

pub fn opposite(self) -> Direction

Returns the opposite direction.

pub fn clockwise(self) -> Option<Direction>

Rotates this direction 90° clockwise around the Y axis.

Only valid for horizontal directions. Returns None for Direction::Up and Direction::Down.

pub fn counter_clockwise(self) -> Option<Direction>

Rotates this direction 90° counter-clockwise around the Y axis.

Only valid for horizontal directions. Returns None for Direction::Up and Direction::Down.

pub fn step_x(self) -> i32

X component of the direction’s unit normal vector.

pub fn step_y(self) -> i32

Y component of the direction’s unit normal vector.

pub fn step_z(self) -> i32

Z component of the direction’s unit normal vector.

pub fn axis(self) -> Axis

Returns the axis this direction lies on.

pub fn axis_direction(self) -> AxisDirection

Returns the axis direction (positive or negative) for this direction.

pub fn from_3d_data_value(id: u8) -> Option<Direction>

Converts a 3D data value (0–5) to a Direction.

Returns None if id is out of range.

pub fn from_2d_data_value(id: u8) -> Option<Direction>

Converts a 2D data value to a horizontal Direction.

Mapping: 0=South, 1=West, 2=North, 3=East. Returns None if id is out of range.

pub fn to_3d_data_value(self) -> u8

Returns the 3D data value (0–5) for this direction.

pub fn to_y_rot(self) -> f32

Returns the Y rotation in degrees for this horizontal direction.

South=0, West=90, North=180, East=270. Returns 0.0 for vertical directions.

pub fn from_y_rot(rot: f64) -> Direction

Converts a Y rotation (in degrees) to the nearest horizontal direction.

South=0°, West=90°, North=180°, East=270°.

pub fn name(self) -> &'static str

Returns the lowercase name of this direction.

pub fn is_horizontal(self) -> bool

Returns true if this is a horizontal direction (North/South/East/West).

pub fn is_vertical(self) -> bool

Returns true if this is a vertical direction (Up/Down).

pub fn read(buf: &mut Bytes) -> Result<Self, TypeError>

Reads a Direction from a wire buffer as a VarInt (0–5).

Errors

Returns TypeError if the buffer is truncated or the value is out of range.

pub fn write(&self, buf: &mut BytesMut)

Writes this Direction to a wire buffer as a VarInt.

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate 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 Display 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