Struct RegionFolder 

pub struct RegionFolder {
    pub write_options: WriteOptions,
    /* private fields */
}

Fields

write_options: WriteOptions

Options to use for writing the chunk.

Implementations

impl RegionFolder

pub fn new<R: Into<PathBuf>>(region_root: R) -> Self

pub fn get_chunk<S>( &mut self, pos_x: i32, pos_z: i32, ) -> Result<Option<RawChunk<S>>, RegionError>

where S: for<'a> FromModifiedUtf8<'a> + Hash + Ord,

Gets the raw chunk at the given chunk position.

Returns Ok(Some(chunk)) if the chunk exists and no errors occurred loading it. Returns Ok(None) if the chunk does not exist and no errors occurred attempting to load it. Returns Err(_) if an error occurred attempting to load the chunk.

pub fn delete_chunk( &mut self, pos_x: i32, pos_z: i32, ) -> Result<bool, RegionError>

Deletes the chunk at the given chunk position, returning whether the chunk existed before it was deleted.

Note that this only marks the chunk as deleted so that it cannot be retrieved, and can be overwritten by other chunks later. It does not decrease the size of the region file.

pub fn set_chunk<S>( &mut self, pos_x: i32, pos_z: i32, chunk: &Compound<S>, ) -> Result<(), RegionError>

where S: ToModifiedUtf8 + Hash + Ord,

Sets the raw chunk at the given position, overwriting the old chunk if it exists.

pub fn all_chunk_positions( &mut self, ) -> Result<impl Iterator<Item = Result<(i32, i32), RegionError>> + '_, RegionError>

Returns an iterator over all existing chunks in all regions.

Trait Implementations

impl Debug for RegionFolder

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

Formats the value using the given formatter.