Skip to main content

SectionWriteGuard

Struct SectionWriteGuard 

Source
pub struct SectionWriteGuard<'a> {
    guard: RwLockWriteGuard<'a, ChunkSection>,
    randomly_ticking_sections: &'a RandomTickSectionBits,
    section_index: usize,
    was_randomly_ticking: bool,
}
Expand description

A chunk-section write guard that republishes derived lock-free metadata.

Fields§

§guard: RwLockWriteGuard<'a, ChunkSection>§randomly_ticking_sections: &'a RandomTickSectionBits§section_index: usize§was_randomly_ticking: bool

Implementations§

Source§

impl<'a> SectionWriteGuard<'a>

Source

fn new( guard: RwLockWriteGuard<'a, ChunkSection>, randomly_ticking_sections: &'a RandomTickSectionBits, section_index: usize, ) -> Self

Methods from Deref<Target = ChunkSection>§

Source

pub fn is_empty(&self) -> bool

Returns true if this section contains no non-air blocks.

Source

pub fn is_randomly_ticking(&self) -> bool

Returns true if this section contains any randomly-ticking blocks or fluids.

Source

pub fn is_randomly_ticking_blocks(&self) -> bool

Returns true if this section contains any randomly-ticking blocks.

Source

pub fn is_randomly_ticking_fluids(&self) -> bool

Returns true if this section contains any randomly-ticking fluids.

Source

pub fn maybe_has_block_light_sources(&self) -> bool

Returns true if this section’s palette may contain block-light sources.

Source

pub fn append_block_light_sources( &self, chunk_min_x: i32, section_min_y: i32, chunk_min_z: i32, sources: &mut Vec<BlockPos>, )

Appends block-light source positions in ScalableLux local-index order.

Source

pub fn non_empty_block_count(&self) -> u16

Returns the number of non-air blocks in this section.

Source

pub fn fluid_count(&self) -> u16

Returns the number of fluid-containing blocks in this section.

Source

pub fn has_fluid(&self) -> bool

Returns if the chunk has fluid.

Source

pub fn ticking_block_count(&self) -> u16

Returns the number of randomly-ticking blocks in this section.

Source

pub fn ticking_fluid_count(&self) -> u16

Returns the number of randomly-ticking fluids in this section.

Source

pub fn recalculate_counts(&mut self)

Recalculates cached counters from extracted per-state metadata.

Iterates the palette (O(palette_size)) rather than every cube cell (O(4096)): each block-state appears at most once in the palette and carries its own occurrence count, so we just classify each unique state and multiply by its count. Mirrors Moonrise’s BlockCountingBitStorage. For a Homogeneous section that’s a single classify; for typical Heterogeneous sections palette is well under 16 entries.

Source

fn recalculate_counts_from_palette( &mut self, counts_for_state: impl FnMut(BlockStateId) -> BlockStateSectionCounts, )

Source

pub fn contains_poi(&self) -> bool

Whether this section’s palette contains any POI-type block state.

Lets the Full-stage POI populate skip the full 4096-block scan_and_populate for the overwhelming majority of sections (stone/dirt/air) that hold no POI blocks — a palette scan of O(≤16) instead of O(4096). Mirrors vanilla’s LevelChunkSection.maybeHas.

Source

pub fn set_block_state( &mut self, x: usize, y: usize, z: usize, new_state: BlockStateId, ) -> BlockStateId

Sets a block state and updates the cached counters.

Returns the old block state.

Source

pub(crate) fn set_block_state_for_generation( &mut self, x: usize, y: usize, z: usize, new_state: BlockStateId, ) -> BlockStateId

Sets a block state through the raw worldgen building path.

Returns the old block state. Cached counters are intentionally not updated; callers must recount before light, promotion, save, or packet serialization.

Source

pub(crate) fn finalize_generation_counts_if_needed(&mut self)

Source

fn ensure_counter_ready_for_delta(&mut self)

Source

fn apply_count_change( &mut self, old_counts: BlockStateSectionCounts, new_counts: BlockStateSectionCounts, )

Source

pub fn write(&self, writer: &mut Cursor<Vec<u8>>)

Writes the chunk section to a writer.

§Panics
  • If the writer fails to write.

Trait Implementations§

Source§

impl Deref for SectionWriteGuard<'_>

Source§

type Target = ChunkSection

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl DerefMut for SectionWriteGuard<'_>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl Drop for SectionWriteGuard<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for SectionWriteGuard<'a>

§

impl<'a> !Send for SectionWriteGuard<'a>

§

impl<'a> !UnwindSafe for SectionWriteGuard<'a>

§

impl<'a> Freeze for SectionWriteGuard<'a>

§

impl<'a> Sync for SectionWriteGuard<'a>

§

impl<'a> Unpin for SectionWriteGuard<'a>

§

impl<'a> UnsafeUnpin for SectionWriteGuard<'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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more