Enum RegionRef

pub enum RegionRef<'a> {
    Borrowed(&'a Region),
    Owned(Box<Region>),
}

A wrapper around Region that allows either a reference to be used or a Box over return types.

Deref is implemented for this enum, so in theory, there should never be a need to match on this.

This is primarily used in the RegionParser trait, so that the implementers can return either a reference to or a box of a Region.

Variants

Borrowed(&'a Region)

Borrowed Region (via reference)

Owned(Box<Region>)

Owned Region (via box)

Methods from Deref<Target = Region>

pub fn validate(&self) -> Result<()>

Validate that this Region contains all valid chunks by trying to parse every chunk.

Important Note

• This method is obviously slow and uses a decent amount of memory. It is recommended to assume the data is correct and validate it as you use the Region::get_chunk and Chunk::parse methods.
• This method should only be used when you absolutely need to validate the data is correct and can’t use the Region::get_chunk and Chunk::parse methods

pub fn get_timestamp(&self, x: u32, z: u32) -> u32

Get a timestamp for a chunk in this Region

Panics

• If x and z are not within 0..=31

pub fn has_chunk(&self, x: u32, z: u32) -> bool

Check if the chunk at x and z have been generated

Panics

• If x and z are not within 0..=31

pub fn get_chunk(&self, chunk_x: u32, chunk_z: u32) -> Result<Option<&Chunk>>

Get a chunk from this Region using relative coordinates within the region

Return Values

• Err if data is invalid
• Ok(None) if the data is valid, but there is no chunk generated
• Ok(Some(&Chunk)) if the data is valid and the chunk exists

This will return a &Chunk which references this Region, if you want an owned version, call Chunk::boxed on the returned chunk.

Panics

• If x and z are not within 0..=31

pub fn get_chunk_from_block( &self, block_x: u32, block_z: u32, ) -> Result<Option<&Chunk>>

Get a chunk from this Region using relative block coordinates within the region

Return Values

• Err if data is invalid
• Ok(None) if the data is valid, but there is no chunk generated
• Ok(Some(&Chunk)) if the data is valid and the chunk exists

This will return a &Chunk which references this Region, if you want an owned version, call Chunk::boxed on the returned chunk.

Panics

• If x and z are not within 0..=511

Trait Implementations

impl<'a> Debug for RegionRef<'a>

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

Formats the value using the given formatter.

impl Deref for RegionRef<'_>

type Target = Region

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> From<&'a Region> for RegionRef<'a>

fn from(value: &'a Region) -> Self

Converts to this type from the input type.

impl From<Box<Region>> for RegionRef<'_>

fn from(value: Box<Region>) -> Self

Converts to this type from the input type.