bedrock-world 0.3.3

Async Minecraft Bedrock world, level.dat, NBT, player and chunk library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Tools for inspecting and editing Minecraft Bedrock `LevelDB` worlds.
//!
//! `bedrock-world` focuses on world-level concepts layered above
//! `bedrock-leveldb`: `level.dat`, little-endian Bedrock NBT, chunk and
//! subchunk decoding, player records, entity summaries, biome data, map/village
//! records, and scan-oriented APIs for launchers or offline tools.
//!
//! The default APIs are deliberately lazy. Opening a [`BedrockWorld`] does not
//! parse the full database; callers choose targeted operations such as
//! [`read_level_dat`], [`BedrockWorld::list_players_blocking`],
//! [`BedrockWorld::parse_chunk_blocking`], or [`BedrockWorld::scan_items_blocking`].
//! Async wrappers use `tokio::task::spawn_blocking` so `LevelDB` and NBT work does
//! not run on foreground async tasks.
//!
//! # Features
//!
//! docs.rs builds this crate with all features enabled. Default builds enable
//! `async` and the `bedrock-leveldb` backend. Disable default features for
//! pure parsing, in-memory storage, `level.dat`, and NBT workflows that should
//! not depend on a database backend.

#![deny(missing_docs)]
#![allow(
    clippy::cast_possible_truncation,
    clippy::cast_possible_wrap,
    clippy::cast_precision_loss,
    clippy::cast_sign_loss,
    clippy::items_after_test_module,
    clippy::missing_errors_doc,
    clippy::must_use_candidate,
    clippy::needless_pass_by_value,
    clippy::struct_excessive_bools,
    clippy::type_complexity,
    clippy::wildcard_imports
)]

/// Chunk keys, subchunk formats, palette data, and legacy terrain helpers.
pub mod chunk;
/// Filesystem discovery for Bedrock world folders.
pub mod discover;
/// Crate-wide error and result types.
pub mod error;
/// `level.dat` header parsing, validation, and atomic write helpers.
pub mod level_dat;
/// Minecraft Bedrock `.mcstructure` files and world placement helpers.
pub mod mcstructure;
/// Little-endian Bedrock NBT reader and writer.
pub mod nbt;
mod nbt_ref;
/// Structured parsers for world, chunk, entity, biome, map, and village data.
pub mod parsed;
/// Player identifiers and raw player record helpers.
pub mod player;
/// Professional map query helpers and guarded world edits.
pub mod query;
/// Storage abstraction and LevelDB backend adapters.
pub mod storage;
/// Terrain surface role helpers shared by chunk decoding and render sampling.
pub mod surface;
/// High-level lazy world handle and scan/render helpers.
pub mod world;

pub use chunk::{
    ActorDigestKey, ActorUid, BedrockDbKey, BlockPalette, BlockPos, BlockState, Chunk, ChunkKey,
    ChunkPos, ChunkRecord, ChunkRecordTag, ChunkVersion, Dimension, EntityData, GlobalRecordKind,
    LEGACY_SUBCHUNK_BLOCK_COUNT, LEGACY_SUBCHUNK_MIN_VALUE_LEN,
    LEGACY_SUBCHUNK_WITH_LIGHT_VALUE_LEN, LEGACY_TERRAIN_BLOCK_COUNT, LEGACY_TERRAIN_VALUE_LEN,
    LegacyBiomeSample, LegacySubChunk, LegacyTerrain, MapRecordId, ParsedVillageKey, SubChunk,
    SubChunkDecodeMode, SubChunkFormat, VillageRecordKind, block_storage_index,
};
pub use discover::{WorldDiscovery, WorldSummary, discover_worlds};
pub use error::{BedrockWorldError, BedrockWorldErrorKind, Result};
pub use level_dat::{
    LevelDatDocument, LevelDatHeader, LevelDatReadWarning, parse_level_dat_document,
    read_level_dat, read_level_dat_document, write_level_dat_atomic, write_level_dat_document,
};
#[cfg(feature = "async")]
pub use level_dat::{read_level_dat_async, write_level_dat_atomic_async};
pub use mcstructure::{
    McStructureBlock, McStructureFile, McStructurePaletteEntry, McStructurePlacement,
    McStructureRotation, McStructureSize, McStructureWritePhase, McStructureWriteProgress,
    McStructureWriteResult, read_mcstructure_file, write_mcstructure_file,
};
pub use nbt::{NbtEvent, NbtReader, NbtRef, NbtTag, NbtValue, NbtView, NbtWriter};
pub use parsed::{
    ActorRecord, ActorResolution, ActorSource, Biome2d, Biome3d, BlockEntityRecord,
    HardcodedSpawnAreaKind, HeightMap2d, ItemStack, MapKnownFields, MapPixels, ParsedActorDigest,
    ParsedBiomeData, ParsedBiomeStorage, ParsedBlockEntity, ParsedChunkData, ParsedChunkRecord,
    ParsedChunkRecordValue, ParsedDbEntry, ParsedDbValue, ParsedEntity, ParsedGlobalData,
    ParsedHardcodedSpawnArea, ParsedMapData, ParsedPlayer, ParsedVillageData, ParsedWorld,
    RetentionMode, WorldParseCategories, WorldParseOptions, WorldParseReport,
};
pub use player::{PlayerData, PlayerId};
pub use query::{
    BlockEntityOverlay, BlockTip, ChunkDetail, ChunkRecordDetail, ChunkRecordFingerprint,
    ChunkRecordQuery, ChunkRecordQueryResult, EntityOverlay, HardcodedSpawnAreaOverlay,
    PendingTickOverlay, RegionOverlayQuery, RegionOverlayQueryOptions, SelectionStats,
    SlimeChunkBounds, SlimeChunkWindow, SlimeWindowSize, VillageOverlay, VillageOverlayIndex,
    WriteGuard, delete_chunks_blocking, fingerprint_chunk_records_many_blocking,
    fingerprint_chunk_records_many_blocking_with_control, is_bedrock_slime_chunk, is_slime_chunk,
    query_block_tip_blocking, query_chunk_detail_blocking, query_chunk_records_many_blocking,
    query_chunk_records_many_blocking_with_control, query_region_overlays_blocking,
    query_region_overlays_blocking_with_control, query_selection_stats_blocking,
    query_slime_chunk_windows, write_chunk_record_nbt_blocking,
};
pub use storage::{
    MemoryStorage, POCKET_CHUNKS_DAT_TERRAIN_VALUE_LEN, PocketChunksDatStorage, StorageBatch,
    StorageCachePolicy, StorageCancelFlag, StorageEntry, StorageEntryRef, StorageOp,
    StoragePipelineOptions, StorageProgressSink, StorageReadOptions, StorageScanMode,
    StorageScanOutcome, StorageScanProgress, StorageThreadingOptions, StorageVisitorControl,
    WorldStorage, backend::BedrockLevelDbStorage,
};
pub use world::{
    BedrockWorld, BiomeDataRequirement, CancelFlag, ChunkBlockEntity, ChunkBounds, ChunkData,
    ChunkDataRequest, ChunkLoadOptions, ChunkLoadPriority, ChunkLoadStats, ExactSurfaceBiomeLoad,
    ExactSurfaceSubchunkPolicy, OpenOptions, ProgressSink, SubchunkDataRequirement, SurfaceColumn,
    SurfaceColumnOptions, TerrainColumnBiome, TerrainColumnOverlay, TerrainColumnSample,
    TerrainColumnSamples, TerrainColumnWater, TerrainSampleSource, TerrainSurfaceRole,
    WorldChunkQueryRegion, WorldChunkQueryRegionData, WorldChunkQueryRegionLoadOptions,
    WorldFormat, WorldFormatHint, WorldPipelineOptions, WorldScanOptions, WorldScanProgress,
    WorldStorageHandle, WorldThreadingOptions, WorldTransaction, terrain_surface_overlay_alpha,
    terrain_surface_role,
};