Struct RegionReader

pub struct RegionReader<'a> { /* private fields */ }

A Minecraft region

This struct is just a wrapper around &'a [u8]
but provides methods to get chunk byte slices & header data.

Implementations

impl<'a> RegionReader<'a>

pub fn new(data: &'a [u8]) -> Result<RegionReader<'a>, McaError>

Initializes a new region
Validates that the region size is at least the size of the header

pub fn inner(&self) -> &'a [u8]

Get the inner data of the region

pub fn chunk_offset(x: usize, z: usize) -> usize

Get a offset depending on the chunk coordinates.
Used in getting byte offsets for chunk location & timestamp in headers

pub fn get_chunk( &self, x: usize, z: usize, ) -> Result<Option<RawChunk<'_>>, McaError>

Get a single RawChunk based of it’s chunk coordinates relative to the region itself.
Will return None if chunk hasn’t been generated yet.

pub fn get_location(&self, offset: usize) -> Option<[u8; 4]>

Get the chunk payload location based off chunk coordinate byte offsets

pub fn get_timestamp(&self, offset: usize) -> Result<[u8; 4], McaError>

Get the timestamp big endian bytes for the chunk based off chunk coordinate byte offsets

pub fn get_u32_timestamp(&self, timestamp_bytes: [u8; 4]) -> u32

Converts the timestamp bytes to u32 unix epoch seconds

pub fn iter(&self) -> RegionIter<'_>

Trait Implementations

impl<'a> Clone for RegionReader<'a>

fn clone(&self) -> RegionReader<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RegionReader<'a>

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

Formats the value using the given formatter.

impl<'a> Ord for RegionReader<'a>

fn cmp(&self, other: &RegionReader<'a>) -> 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.

impl<'a> PartialEq for RegionReader<'a>

fn eq(&self, other: &RegionReader<'a>) -> 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<'a> PartialOrd for RegionReader<'a>

fn partial_cmp(&self, other: &RegionReader<'a>) -> 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<'a> Eq for RegionReader<'a>

impl<'a> StructuralPartialEq for RegionReader<'a>