Struct BlockPos 

pub struct BlockPos {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

A block position. x/z must fit 26 signed bits, y 12 signed bits to be encodable.

Fields

x: i32

X coordinate.

y: i32

Y coordinate.

z: i32

Z coordinate.

Implementations

impl BlockPos

pub const fn new(x: i32, y: i32, z: i32) -> BlockPos

Creates a position.

pub const fn unpack(v: u64, layout: PositionLayout) -> BlockPos

Unpacks a 64-bit value with the given layout.

pub const fn is_packable(&self) -> bool

Whether the coordinates fit the packed representation.

pub fn pack(&self, layout: PositionLayout) -> Result<u64, EncodeError>

Packs into 64 bits; fails if a coordinate does not fit.

pub fn read( r: &mut Reader<'_>, layout: PositionLayout, ) -> Result<BlockPos, DecodeError>

Reads a packed position with the given layout.

pub fn write( &self, w: &mut BytesMut, layout: PositionLayout, ) -> Result<(), EncodeError>

Writes a packed position with the given layout.

Trait Implementations

impl Clone for BlockPos

fn clone(&self) -> BlockPos

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockPos

impl Debug for BlockPos

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

Formats the value using the given formatter.

impl Default for BlockPos

fn default() -> BlockPos

Returns the “default value” for a type.

impl Eq for BlockPos

impl Hash for BlockPos

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 Ord for BlockPos

fn cmp(&self, other: &BlockPos) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BlockPos

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockPos

fn partial_cmp(&self, other: &BlockPos) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BlockPos