Skip to main content

EntityStaticRange

Struct EntityStaticRange 

Source
pub struct EntityStaticRange<I: EntityId, const N: usize> { /* private fields */ }
Expand description

A range of IDs materialized at compile-time.

The purpose of this type is to support indexing with the [_] operator, whether rustc likes it or not. Internally, this is done by preparing an array which lists all the IDs in the range, so that we may freely return references to it.

Implementations§

Source§

impl<T: EntityTag, const N: usize> EntityStaticRange<EntityIdU8<T>, N>

Source

pub const fn new_const(base: usize) -> Self

Source§

impl<T: EntityTag, const N: usize> EntityStaticRange<EntityIdU16<T>, N>

Source

pub const fn new_const(base: usize) -> Self

Source§

impl<T: EntityTag, const N: usize> EntityStaticRange<EntityIdU32<T>, N>

Source

pub const fn new_const(base: usize) -> Self

Source§

impl<I: EntityId, const N: usize> EntityStaticRange<I, N>

Source

pub const fn index_const(&self, idx: usize) -> I

Returns self[idx], but available in a const context.

Source

pub fn index_of(&self, id: I) -> Option<usize>

Return the position of id in this range, if present.

This is done in O(1) time, without scanning through the materialized array.

Source

pub fn contains(&self, id: I) -> bool

Methods from Deref<Target = [I; N]>§

1.57.0 · Source

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

1.77.0 · Source

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

§Example
let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);
Source

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples
#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}
Source

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples
#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

Trait Implementations§

Source§

impl<I: Clone + EntityId, const N: usize> Clone for EntityStaticRange<I, N>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Copy + EntityId, const N: usize> Copy for EntityStaticRange<I, N>

Source§

impl<I: Debug + EntityId, const N: usize> Debug for EntityStaticRange<I, N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<I: EntityId, const N: usize> Deref for EntityStaticRange<I, N>

Source§

type Target = [I; N]

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<I: EntityId, const N: usize> IntoIterator for EntityStaticRange<I, N>

Source§

type Item = I

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<I, N>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<I, const N: usize> Freeze for EntityStaticRange<I, N>
where I: Freeze,

§

impl<I, const N: usize> RefUnwindSafe for EntityStaticRange<I, N>
where I: RefUnwindSafe,

§

impl<I, const N: usize> Send for EntityStaticRange<I, N>

§

impl<I, const N: usize> Sync for EntityStaticRange<I, N>

§

impl<I, const N: usize> Unpin for EntityStaticRange<I, N>
where I: Unpin,

§

impl<I, const N: usize> UnsafeUnpin for EntityStaticRange<I, N>
where I: UnsafeUnpin,

§

impl<I, const N: usize> UnwindSafe for EntityStaticRange<I, N>
where I: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.