Struct RegionReader

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

A Minecraft region

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

Implementations§

Source§

impl<'a> RegionReader<'a>

Source

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

Source

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

Get the inner data of the region

Source

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

Source

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.

Source

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

Get the chunk payload location based off chunk coordinate byte offsets

Source

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

Source

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

Converts the timestamp bytes to u32 unix epoch seconds

Source

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

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn cmp(&self, other: &RegionReader<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

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

Source§

fn eq(&self, other: &RegionReader<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> PartialOrd for RegionReader<'a>

Source§

fn partial_cmp(&self, other: &RegionReader<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<'a> Eq for RegionReader<'a>

Source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for RegionReader<'a>

§

impl<'a> RefUnwindSafe for RegionReader<'a>

§

impl<'a> Send for RegionReader<'a>

§

impl<'a> Sync for RegionReader<'a>

§

impl<'a> Unpin for RegionReader<'a>

§

impl<'a> UnwindSafe for RegionReader<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.