Struct ark_api::world::EntityLayerMask

#[repr(transparent)]
pub struct EntityLayerMask(_);

Represents an entity layer filter that can be used with entity queries or raycasts.

Implementations

impl EntityLayerMask

pub const fn layer(layer: usize) -> Self

Returns a new mask that includes only the given layer.

pub const fn with(self, other: EntityLayerMask) -> Self

Returns a new mask that includes the union of the layers of this mask and the other mask.

pub const fn except(self, other: EntityLayerMask) -> Self

Returns a new mask that includes the layers that this mask includes except the ones in the other mask.

pub const fn with_layer(self, layer: usize) -> Self

Returns a new mask that also includes the given layer.

pub const fn except_layer(self, layer: usize) -> Self

Returns a new mask that excludes the given layer. If the layer was already excluded from the mask this has no effect.

pub const fn from_value(value: u64) -> Self

Create from a raw mask value.

pub const fn value(&self) -> u64

Returns the raw mask value. Bits set to 1 indicate that the layer should be included.

pub const fn everything() -> Self

All layers.

pub const fn nothing() -> Self

No layers.

Trait Implementations

impl BitOr<EntityLayerMask> for EntityLayerMask

fn bitor(self, rhs: Self) -> Self::Output

Returns a new mask that includes the union of the layers of this mask and the other mask.

Identical to EntityLayerMask::with.

type Output = EntityLayerMask

The resulting type after applying the | operator.

impl BitOrAssign<EntityLayerMask> for EntityLayerMask

fn bitor_assign(&mut self, rhs: Self)

Returns a new mask that includes the union of the layers of this mask and the other mask.

Identical to EntityLayerMask::with.

impl Clone for EntityLayerMask

fn clone(&self) -> EntityLayerMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityLayerMask

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityLayerMask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for EntityLayerMask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<EntityLayerMask> for EntityLayerMask

fn eq(&self, other: &EntityLayerMask) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a_, C_: Context> Readable<'a_, C_> for EntityLayerMask

fn read_from<R_: Reader<'a_, C_>>(_reader_: &mut R_) -> Result<Self, C_::Error>

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut(
    context: &mut C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_stream_buffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_file_with_ctx(
    context: C,
    path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>

impl Serialize for EntityLayerMask

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<C_: Context> Writable<C_> for EntityLayerMask

fn write_to<T_: ?Sized + Writer<C_>>(
    &self,
    _writer_: &mut T_
) -> Result<(), C_::Error>

fn write_to_buffer_with_ctx(
    &self,
    context: C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut(
    &self,
    context: &mut C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx(
    &self,
    context: C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut(
    &self,
    context: &mut C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>(
    &self,
    context: C,
    stream: S
) -> Result<(), <C as Context>::Error> where
    S: Write, 

fn write_to_file_with_ctx(
    &self,
    context: C,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Copy for EntityLayerMask

impl Eq for EntityLayerMask

impl StructuralEq for EntityLayerMask

impl StructuralPartialEq for EntityLayerMask

impl<T_> ZeroCopyable<T_> for EntityLayerMask where
    u64: ZeroCopyable<T_>,