Struct Read 

pub struct Read<'ticket> { /* private fields */ }

Read access to a Space that may be currently in a Universe.

Obtain this using Handle::read() or Space::read().

Implementations

impl Read<'_>

pub fn bounds(&self) -> GridAab

Returns the GridAab describing the bounds of this space; no blocks may exist outside it.

pub fn get_block_index(&self, position: impl Into<Cube>) -> Option<BlockIndex>

Returns the internal unstable numeric ID for the block at the given position, which may be mapped to a Block by Read::block_data(). If you are looking for simple access, use space[position] (the core::ops::Index trait) instead.

These IDs may be used to perform efficient processing of many blocks, but they may be renumbered after any mutation.

pub fn get_evaluated(&self, position: impl Into<Cube>) -> &EvaluatedBlock

Returns the EvaluatedBlock of the block in this space at the given position.

If out of bounds, returns the evaluation of AIR.

pub fn get_lighting(&self, cube: impl Into<Cube>) -> PackedLight

Returns the light occupying the given cube.

This value may be considered as representing the average of the light reflecting off of all surfaces within, or immediately adjacent to and facing toward, this cube. If there are no such surfaces, or if the given position is out of bounds, the result is arbitrary. If the position is within an opaque block, the result is black.

Lighting is updated asynchronously after modifications, so all above claims about the meaning of this value are actually “will eventually be, if no more changes are made”.

pub fn extract<'s, C, V>( &'s self, bounds: GridAab, extractor: impl FnMut(Extract<'s>) -> V, ) -> Vol<C>

where C: Deref<Target = [V]> + FromIterator<V>,

Copy data out of a portion of the space in a caller-chosen format.

The given bounds must be fully contained within self.bounds().

pub fn block_data(&self) -> &[SpaceBlockData]

Returns data about all the blocks assigned internal IDs (indices) in the space, as well as placeholder data for any deallocated indices.

The indices of this slice correspond to the results of Space::get_block_index().

pub fn fluff( &self, ) -> impl Listen<Msg = SpaceFluff, Listener = DynListener<SpaceFluff>> + '_

Returns the source of fluff occurring in this space.

pub fn physics(&self) -> &SpacePhysics

Returns the current SpacePhysics data, which determines global characteristics such as the behavior of light and gravity.

pub fn spawn(&self) -> &Spawn

Returns the current default Spawn, which determines where new Characters are placed in the space if no alternative applies.

pub fn behaviors(&self) -> &BehaviorSet<Space>

Returns the BehaviorSet of behaviors attached to this space.

Trait Implementations

impl<'ticket> Clone for Read<'ticket>

fn clone(&self) -> Read<'ticket>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Read<'_>

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

Formats the value using the given formatter.

impl<T: Into<Cube>> Index<T> for Read<'_>

fn index(&self, position: T) -> &Self::Output

Gets a reference to the block in this space at the given position.

If the position is out of bounds, returns AIR.

There is no corresponding IndexMut implementation; use Mutation::set() or Mutation::fill() to modify blocks.

type Output = Block

The returned type after indexing.

impl Listen for Read<'_>

Registers a listener for mutations of this space.

type Msg = SpaceChange

The type of message which may be obtained from this source.

type Listener = <Notifier<<Read<'_> as Listen>::Msg, Arc<dyn Listener<<Read<'_> as Listen>::Msg> + Sync + Send>> as Listen>::Listener

The type which all added listeners must be convertible to.

fn listen_raw(&self, listener: Self::Listener)

Subscribe the given Listener to this source of messages.

fn listen<L>(&self, listener: L)

where L: IntoListener<Self::Listener, Self::Msg>, Self: Sized,

Subscribe the given Listener to this source of messages.

impl Serialize for Read<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'ticket> Copy for Read<'ticket>