Struct RegionWriter

pub struct RegionWriter { /* private fields */ }

A writer used to write chunks to a region (mca) file.

Implementations

impl RegionWriter

pub fn new() -> RegionWriter

Creates a new region writer

pub fn push_chunk( &mut self, raw_data: &[u8], coordinate: (u8, u8), ) -> Result<(), McaError>

Pushes a raw chunk into the writer
Defaults to LZ4 compression, use [push_chunk_with_compression] for other compression types.

Timestamp will be current time since UNIX_EPOCH, use [push_pending_chunk] to override it.

pub fn push_chunk_with_compression( &mut self, raw_data: &[u8], coordinate: (u8, u8), compression_type: CompressionType, ) -> Result<(), McaError>

Pushes a raw chunk into the writer
This specifies the compression type used

pub fn push_pending_chunk(&mut self, chunk: PendingChunk)

Just pushes a PendingChunk to the writer

pub fn write<'a, W>(&self, w: &'a mut W) -> Result<(), McaError>

where W: Write,

Writes all chunks into one region file.

Example

use mca::{RegionWriter};

let mut writer = RegionWriter::new();

// Push some chunk data
// ...

let mut buf: Vec<u8> = vec![];
writer.write(&mut buf).unwrap();

std::fs::File::write("r.0.0.mca", &buf).unwrap();

Trait Implementations

impl Clone for RegionWriter

fn clone(&self) -> RegionWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegionWriter

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

Formats the value using the given formatter.

impl Ord for RegionWriter

fn cmp(&self, other: &RegionWriter) -> 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 PartialEq for RegionWriter

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

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

impl StructuralPartialEq for RegionWriter