Struct Mask Copy item path

impl<T, const N: usize> Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

pub fn reverse(self) -> Mask<T, N>

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

Reverse the order of the elements in the mask.

pub fn rotate_elements_left<const OFFSET: usize>(self) -> Mask<T, N>

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

Rotates the mask such that the first OFFSET elements of the slice move to the end while the last self.len() - OFFSET elements move to the front. After calling rotate_elements_left, the element previously at index OFFSET will become the first element in the slice.

pub fn rotate_elements_right<const OFFSET: usize>(self) -> Mask<T, N>

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

Rotates the mask such that the first self.len() - OFFSET elements of the mask move to the end while the last OFFSET elements move to the front. After calling rotate_elements_right, the element previously at index self.len() - OFFSET will become the first element in the slice.

pub fn shift_elements_left<const OFFSET: usize>( self, padding: bool, ) -> Mask<T, N>

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

Shifts the mask elements to the left by OFFSET, filling in with padding from the right.

pub fn shift_elements_right<const OFFSET: usize>( self, padding: bool, ) -> Mask<T, N>

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

Shifts the mask elements to the right by OFFSET, filling in with padding from the left.

pub fn interleave(self, other: Mask<T, N>) -> (Mask<T, N>, Mask<T, N>)

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

Interleave two masks.

The resulting masks contain elements taken alternatively from self and other, first filling the first result, and then the second.

The reverse of this operation is Mask::deinterleave.

let a = mask32x4::from_array([false, true, false, true]);
let b = mask32x4::from_array([false, false, true, true]);
let (x, y) = a.interleave(b);
assert_eq!(x.to_array(), [false, false, true, false]);
assert_eq!(y.to_array(), [false, true, true, true]);

pub fn deinterleave(self, other: Mask<T, N>) -> (Mask<T, N>, Mask<T, N>)

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

Deinterleave two masks.

The first result takes every other element of self and then other, starting with the first element.

The second result takes every other element of self and then other, starting with the second element.

The reverse of this operation is Mask::interleave.

let a = mask32x4::from_array([false, true, false, true]);
let b = mask32x4::from_array([false, false, true, true]);
let (x, y) = a.deinterleave(b);
assert_eq!(x.to_array(), [false, false, false, true]);
assert_eq!(y.to_array(), [true, true, false, true]);

pub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>
where LaneCount<M>: SupportedLaneCount,

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

Resize a mask.

If M > N, extends the length of a mask, setting the new elements to value. If M < N, truncates the mask to the first M elements.

let x = mask32x4::from_array([false, true, true, false]);
assert_eq!(x.resize::<8>(true).to_array(), [false, true, true, false, true, true, true, true]);
assert_eq!(x.resize::<2>(true).to_array(), [false, true]);

pub fn extract<const START: usize, const LEN: usize>(self) -> Mask<T, LEN>
where LaneCount<LEN>: SupportedLaneCount,

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

Extract a vector from another vector.

let x = mask32x4::from_array([false, true, true, false]);
assert_eq!(x.extract::<1, 2>().to_array(), [true, true]);

impl<T, const N: usize> Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

pub fn splat(value: bool) -> Mask<T, N>

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

Constructs a mask by setting all elements to the given value.

pub fn from_array(array: [bool; N]) -> Mask<T, N>

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

Converts an array of bools to a SIMD mask.

pub fn to_array(self) -> [bool; N]

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

Converts a SIMD mask to an array of bools.

pub unsafe fn from_int_unchecked(value: Simd<T, N>) -> Mask<T, N>

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

Converts a vector of integers to a mask, where 0 represents false and -1 represents true.

§Safety

All elements must be either 0 or -1.

pub fn from_int(value: Simd<T, N>) -> Mask<T, N>

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

Converts a vector of integers to a mask, where 0 represents false and -1 represents true.

§Panics

Panics if any element is not 0 or -1.

pub fn to_int(self) -> Simd<T, N>

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

Converts the mask to a vector of integers, where 0 represents false and -1 represents true.

pub fn cast(self) -> Mask<U, N>
where U: MaskElement,

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

Converts the mask to a mask of any other element size.

pub unsafe fn test_unchecked(&self, index: usize) -> bool

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

Tests the value of the specified element.

§Safety

index must be less than self.len().

pub fn test(&self, index: usize) -> bool

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

Tests the value of the specified element.

§Panics

Panics if index is greater than or equal to the number of elements in the vector.

pub unsafe fn set_unchecked(&mut self, index: usize, value: bool)

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

Sets the value of the specified element.

§Safety

index must be less than self.len().

pub fn set(&mut self, index: usize, value: bool)

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

Sets the value of the specified element.

§Panics

Panics if index is greater than or equal to the number of elements in the vector.

pub fn any(self) -> bool

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

Returns true if any element is set, or false otherwise.

pub fn all(self) -> bool

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

Returns true if all elements are set, or false otherwise.

pub fn to_bitmask(self) -> u64

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

Creates a bitmask from a mask.

Each bit is set if the corresponding element in the mask is true. If the mask contains more than 64 elements, the bitmask is truncated to the first 64.

pub fn from_bitmask(bitmask: u64) -> Mask<T, N>

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

Creates a mask from a bitmask.

For each bit, if it is set, the corresponding element in the mask is set to true. If the mask contains more than 64 elements, the remainder are set to false.

pub fn first_set(self) -> Option<usize>

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

Finds the index of the first set element.

assert_eq!(mask32x8::splat(false).first_set(), None);
assert_eq!(mask32x8::splat(true).first_set(), Some(0));

let mask = mask32x8::from_array([false, true, false, false, true, false, false, true]);
assert_eq!(mask.first_set(), Some(1));

impl<T, const N: usize> Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

pub fn select( self, true_values: Simd<U, N>, false_values: Simd<U, N>, ) -> Simd<U, N>
where U: SimdElement<Mask = T>,

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

Choose elements from two vectors.

For each element in the mask, choose the corresponding element from true_values if that element mask is true, and false_values if that element mask is false.

§Examples

let a = Simd::from_array([0, 1, 2, 3]);
let b = Simd::from_array([4, 5, 6, 7]);
let mask = Mask::from_array([true, false, false, true]);
let c = mask.select(a, b);
assert_eq!(c.to_array(), [0, 5, 6, 3]);

pub fn select_mask( self, true_values: Mask<T, N>, false_values: Mask<T, N>, ) -> Mask<T, N>

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

Choose elements from two masks.

For each element in the mask, choose the corresponding element from true_values if that element mask is true, and false_values if that element mask is false.

§Examples

let a = Mask::<i32, 4>::from_array([true, true, false, false]);
let b = Mask::<i32, 4>::from_array([false, false, true, true]);
let mask = Mask::<i32, 4>::from_array([true, false, false, true]);
let c = mask.select_mask(a, b);
assert_eq!(c.to_array(), [true, false, true, false]);

Trait Implementations§

impl<T, const N: usize> BitAnd<Mask<T, N>> for bool
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the & operator.

fn bitand(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the & operation. Read more

impl<T, const N: usize> BitAnd<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the & operator.

fn bitand(self, rhs: bool) -> Mask<T, N>

Performs the & operation. Read more

impl<T, const N: usize> BitAnd for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the & operator.

fn bitand(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the & operation. Read more

impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitand_assign(&mut self, rhs: bool)

Performs the &= operation. Read more

impl<T, const N: usize> BitAndAssign for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitand_assign(&mut self, rhs: Mask<T, N>)

Performs the &= operation. Read more

impl<T, const N: usize> BitOr<Mask<T, N>> for bool
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the | operator.

fn bitor(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the | operation. Read more

impl<T, const N: usize> BitOr<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the | operator.

fn bitor(self, rhs: bool) -> Mask<T, N>

Performs the | operation. Read more

impl<T, const N: usize> BitOr for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the | operator.

fn bitor(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the | operation. Read more

impl<T, const N: usize> BitOrAssign<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitor_assign(&mut self, rhs: bool)

Performs the |= operation. Read more

impl<T, const N: usize> BitOrAssign for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitor_assign(&mut self, rhs: Mask<T, N>)

Performs the |= operation. Read more

impl<T, const N: usize> BitXor<Mask<T, N>> for bool
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Mask<T, N>) -> <bool as BitXor<Mask<T, N>>>::Output

Performs the ^ operation. Read more

impl<T, const N: usize> BitXor<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: bool) -> <Mask<T, N> as BitXor<bool>>::Output

Performs the ^ operation. Read more

impl<T, const N: usize> BitXor for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Mask<T, N>) -> <Mask<T, N> as BitXor>::Output

Performs the ^ operation. Read more

impl<T, const N: usize> BitXorAssign<bool> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitxor_assign(&mut self, rhs: bool)

Performs the ^= operation. Read more

impl<T, const N: usize> BitXorAssign for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitxor_assign(&mut self, rhs: Mask<T, N>)

Performs the ^= operation. Read more

impl<T, const N: usize> Clone for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn clone(&self) -> Mask<T, N>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T, const N: usize> Debug for Mask<T, N>
where T: MaskElement + Debug, LaneCount<N>: SupportedLaneCount,

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

Formats the value using the given formatter. Read more

impl<T, const N: usize> Default for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn default() -> Mask<T, N>

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

impl<T, const N: usize> From<[bool; N]> for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn from(array: [bool; N]) -> Mask<T, N>

Converts to this type from the input type.

impl<T, const N: usize> From<Mask<T, N>> for [bool; N]
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn from(vector: Mask<T, N>) -> [bool; N]

Converts to this type from the input type.

impl<const N: usize> From<Mask<i16, N>> for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i16, N>) -> Mask<i32, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i16, N>> for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i16, N>) -> Mask<i64, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i16, N>> for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i16, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i16, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i16, N>) -> Mask<isize, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i32, N>> for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i32, N>) -> Mask<i16, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i32, N>> for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i32, N>) -> Mask<i64, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i32, N>> for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i32, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i32, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i32, N>) -> Mask<isize, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i64, N>> for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i64, N>) -> Mask<i16, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i64, N>> for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i64, N>) -> Mask<i32, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i64, N>> for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i64, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i64, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i64, N>) -> Mask<isize, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i8, N>> for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i8, N>) -> Mask<i16, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i8, N>> for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i8, N>) -> Mask<i32, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i8, N>> for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i8, N>) -> Mask<i64, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i8, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i8, N>) -> Mask<isize, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<isize, N>> for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<isize, N>) -> Mask<i16, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<isize, N>> for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<isize, N>) -> Mask<i32, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<isize, N>> for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<isize, N>) -> Mask<i64, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<isize, N>> for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<isize, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<T, const N: usize> Not for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ! operator.

fn not(self) -> <Mask<T, N> as Not>::Output

Performs the unary ! operation. Read more

impl<T, const N: usize> PartialEq for Mask<T, N>
where T: MaskElement + PartialEq, LaneCount<N>: SupportedLaneCount,

fn eq(&self, other: &Mask<T, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl<T, const N: usize> PartialOrd for Mask<T, N>
where T: MaskElement + PartialOrd, LaneCount<N>: SupportedLaneCount,

fn partial_cmp(&self, other: &Mask<T, N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<const N: usize> SimdOrd for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<i16, N>) -> Mask<i16, N>

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

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<i16, N>) -> Mask<i16, N>

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

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<i16, N>, max: Mask<i16, N>) -> Mask<i16, N>

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<i32, N>) -> Mask<i32, N>

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

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<i32, N>) -> Mask<i32, N>

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

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<i32, N>, max: Mask<i32, N>) -> Mask<i32, N>

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<i64, N>) -> Mask<i64, N>

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

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<i64, N>) -> Mask<i64, N>

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

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<i64, N>, max: Mask<i64, N>) -> Mask<i64, N>

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<i8, N>) -> Mask<i8, N>

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

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<i8, N>) -> Mask<i8, N>

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

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<i8, N>, max: Mask<i8, N>) -> Mask<i8, N>

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<isize, N>) -> Mask<isize, N>

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

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<isize, N>) -> Mask<isize, N>

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

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<isize, N>, max: Mask<isize, N>) -> Mask<isize, N>

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdPartialEq for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i16, N>

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

The mask type returned by each comparison.

fn simd_eq(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is equal to the corresponding element in other.

fn simd_ne(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is not equal to the corresponding element in other.

impl<const N: usize> SimdPartialEq for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i32, N>

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

The mask type returned by each comparison.

fn simd_eq(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is equal to the corresponding element in other.

fn simd_ne(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is not equal to the corresponding element in other.

impl<const N: usize> SimdPartialEq for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i64, N>

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

The mask type returned by each comparison.

fn simd_eq(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is equal to the corresponding element in other.

fn simd_ne(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is not equal to the corresponding element in other.

impl<const N: usize> SimdPartialEq for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i8, N>

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

The mask type returned by each comparison.

fn simd_eq(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is equal to the corresponding element in other.

fn simd_ne(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is not equal to the corresponding element in other.

impl<const N: usize> SimdPartialEq for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<isize, N>

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

The mask type returned by each comparison.

fn simd_eq( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is equal to the corresponding element in other.

fn simd_ne( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is not equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_lt(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is less than the corresponding element in other.

fn simd_le(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is greater than the corresponding element in other.

fn simd_ge(self, other: Mask<i16, N>) -> <Mask<i16, N> as SimdPartialEq>::Mask

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

Test if each element is greater than or equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_lt(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is less than the corresponding element in other.

fn simd_le(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is greater than the corresponding element in other.

fn simd_ge(self, other: Mask<i32, N>) -> <Mask<i32, N> as SimdPartialEq>::Mask

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

Test if each element is greater than or equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_lt(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is less than the corresponding element in other.

fn simd_le(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is greater than the corresponding element in other.

fn simd_ge(self, other: Mask<i64, N>) -> <Mask<i64, N> as SimdPartialEq>::Mask

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

Test if each element is greater than or equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<i8, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_lt(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is less than the corresponding element in other.

fn simd_le(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is greater than the corresponding element in other.

fn simd_ge(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

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

Test if each element is greater than or equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

fn simd_lt( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is less than the corresponding element in other.

fn simd_le( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is greater than the corresponding element in other.

fn simd_ge( self, other: Mask<isize, N>, ) -> <Mask<isize, N> as SimdPartialEq>::Mask

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

Test if each element is greater than or equal to the corresponding element in other.

impl<T, const N: usize> Copy for Mask<T, N>
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

Auto Trait Implementations§

impl<T, const N: usize> UnwindSafe for Mask<T, N>
where T: UnwindSafe,

Blanket Implementations§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

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

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

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

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

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

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

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

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

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

Converts &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)

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

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

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

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

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

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

Performs a conversion from angle.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.

impl<T, U> FromStimulus for T
where U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

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

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, U> IntoAngle for T
where U: FromAngle<T>,

fn into_angle(self) -> U

Performs a conversion into T.

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

impl<T, U> IntoColor for T
where U: FromColor<T>,

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

impl<T, U> IntoColorUnclamped for T
where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

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

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.

impl<T> IntoStimulus<T> for T

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

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> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SerializableKey for T

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more

impl<T> StorageAccess<T> for T

fn as_borrowed(&self) -> &T

Borrows the value.

fn into_taken(self) -> T

Takes the value.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T, U> TryIntoColor for T
where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<C, U> UintsFrom<C> for U
where C: IntoUints,

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

impl<C, U> UintsInto<C> for U
where C: FromUints,

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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

impl<T> ErasedDestructor for T
where T: 'static,