Struct all_is_cubes :: math :: FaceMap Copy item path

impl<V> FaceMap<V>

pub fn from_fn(f: impl FnMut(Face6) -> V) -> FaceMap<V>

Constructs a FaceMap by using the provided function to compute a value for each Face6 enum variant.

pub fn negatives(self) -> Vector3D<V, U>
where V: Copy,

Returns a vector containing the values for each negative face.

pub fn positives(self) -> Vector3D<V, U>
where V: Copy,

Returns a vector containing the values for each positive face.

pub fn iter(&self) -> impl Iterator<Item = (Face6, &V)>

Iterate over the map’s key-value pairs by reference, in the same order as Face6::ALL.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (Face6, &mut V)>

Iterate over the map’s key-value pairs by mutable reference, in the same order as Face6::ALL.

pub fn values(&self) -> impl Iterator<Item = &V>

Iterate over the map values by reference, in the same order as Face6::ALL.

pub fn into_values(self) -> [V; 6]

Convert to an array, whose elements are arranged in the same order as Face6::ALL.

pub fn into_values_iter(self) -> impl Iterator<Item = V>

Convert to an iterator, whose items are arranged in the same order as Face6::ALL.

pub fn map(self, f: impl FnMut(Face6, V) -> U) -> FaceMap

Transform values.

pub fn zip<U, R>( self, other: FaceMap, f: impl FnMut(Face6, V, U) -> R, ) -> FaceMap<R>

Combine two FaceMaps using a function applied to each pair of corresponding values.

pub fn with(self, face: Face6, value: V) -> FaceMap<V>

Returns this map with one entry’s value replaced.

This may be used for constructing a map with only one interesting entry:

use all_is_cubes::math::{Face6, FaceMap};

assert_eq!(
    FaceMap::default().with(Face6::PY, 10),
    {
        let mut m = FaceMap::default();
        m[Face6::PY] = 10;
        m
    },
);

pub fn rotate(self, rotation: GridRotation) -> FaceMap<V>

Shuffle the values in this map according to the given rotation.

impl<V> FaceMap<V>
where V: Clone,

pub fn repeat(value: V) -> FaceMap<V>

Constructs a FaceMap containing clones of the provided value.

impl<V> FaceMap<V>
where V: Copy,

pub const fn repeat_copy(value: V) -> FaceMap<V>

Constructs a FaceMap containing copies of the provided value.

This is practically identical to FaceMap::repeat() except that it is a const fn. It may be removed from future major versions once Rust supports const trait function calls.

Trait Implementations§

impl<V> Add for FaceMap<V>
where V: Add,

fn add(self, other: FaceMap<V>) -> FaceMap<<V as Add>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as Add>::Output>

The resulting type after applying the + operator.

impl<'arbitrary, V> Arbitrary<'arbitrary> for FaceMap<V>
where V: Arbitrary<'arbitrary>,

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<FaceMap<V>, Error>

Generate an arbitrary value of Self from the given unstructured data. Read more

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<FaceMap<V>, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

impl<V> BitAnd for FaceMap<V>
where V: BitAnd,

fn bitand(self, other: FaceMap<V>) -> FaceMap<<V as BitAnd>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as BitAnd>::Output>

The resulting type after applying the & operator.

impl<V> BitOr for FaceMap<V>
where V: BitOr,

fn bitor(self, other: FaceMap<V>) -> FaceMap<<V as BitOr>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as BitOr>::Output>

The resulting type after applying the | operator.

impl<V> BitXor for FaceMap<V>
where V: BitXor,

fn bitxor(self, other: FaceMap<V>) -> FaceMap<<V as BitXor>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as BitXor>::Output>

The resulting type after applying the ^ operator.

impl<V> Clone for FaceMap<V>
where V: Clone,

fn clone(&self) -> FaceMap<V>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<V> Debug for FaceMap<V>
where V: Debug + PartialEq,

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

In addition to the usual formatting behaviors, FaceMap will detect whether elements are equal and avoid redundant printing.

impl<V> Default for FaceMap<V>
where V: Default,

fn default() -> FaceMap<V>

Returns the “default value” for a type. Read more

impl<V> Div for FaceMap<V>
where V: Div,

fn div(self, other: FaceMap<V>) -> FaceMap<<V as Div>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as Div>::Output>

The resulting type after applying the / operator.

impl<V> Exhaust for FaceMap<V>
where V: Exhaust,

type Iter = ExhaustFaceMap<V>

Type of iterator returned by Self::exhaust(). Read more

fn exhaust() -> <FaceMap<V> as Exhaust>::Iter

Returns an iterator over all values of this type. Read more

impl<V> Hash for FaceMap<V>
where V: Hash,

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl<V> Index<Face6> for FaceMap<V>

type Output = V

The returned type after indexing.

fn index(&self, face: Face6) -> &V

Performs the indexing (container[index]) operation. Read more

impl<V> IndexMut<Face6> for FaceMap<V>

fn index_mut(&mut self, face: Face6) -> &mut V

Performs the mutable indexing (container[index]) operation. Read more

impl<V> Mul for FaceMap<V>
where V: Mul,

fn mul(self, other: FaceMap<V>) -> FaceMap<<V as Mul>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as Mul>::Output>

The resulting type after applying the * operator.

impl<V> PartialEq for FaceMap<V>
where V: PartialEq,

fn eq(&self, other: &FaceMap<V>) -> bool

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

1.0.0 · source§

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<V> Rem for FaceMap<V>
where V: Rem,

fn rem(self, other: FaceMap<V>) -> FaceMap<<V as Rem>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as Rem>::Output>

The resulting type after applying the % operator.

impl<V> Sub for FaceMap<V>
where V: Sub,

fn sub(self, other: FaceMap<V>) -> FaceMap<<V as Sub>::Output>

Apply the operator pairwise to the values for all six faces.

type Output = FaceMap<<V as Sub>::Output>

The resulting type after applying the - operator.

impl<V> Copy for FaceMap<V>
where V: Copy,

impl<V> Eq for FaceMap<V>
where V: Eq,

impl<V> StructuralPartialEq for FaceMap<V>

Auto Trait Implementations§

impl<V> UnwindSafe for FaceMap<V>
where V: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Copy,

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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