# Struct std::simd::prelude::Mask

source ·

    pub struct Mask<T, const LANES: usize>(/* private fields */)
    where
        T: MaskElement,
        LaneCount<LANES>: SupportedLaneCount;

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Expand description

A SIMD vector mask for `LANES` elements of width specified by `Element`.

Masks represent boolean inclusion/exclusion on a per-lane basis.

The layout of this type is unspecified, and may change between platforms and/or Rust versions, and code should not assume that it is equivalent to `[T; LANES]`.

## Implementations§

source§

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

source

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

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

Construct a mask by setting all lanes to the given value.

source

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

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

Converts an array of bools to a SIMD mask.

source

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

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

Converts a SIMD mask to an array of bools.

source

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

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

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

##### Safety

All lanes must be either 0 or -1.

source

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

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

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

##### Panics

Panics if any lane is not 0 or -1.

source

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

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

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

source

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

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

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

source

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

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

Tests the value of the specified lane.

##### Safety

`lane` must be less than `LANES`.

source

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

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

Tests the value of the specified lane.

##### Panics

Panics if `lane` is greater than or equal to the number of lanes in the vector.

source

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

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

Sets the value of the specified lane.

##### Safety

`lane` must be less than `LANES`.

source

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

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

Sets the value of the specified lane.

##### Panics

Panics if `lane` is greater than or equal to the number of lanes in the vector.

source

#### pub fn any(self) -> bool

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

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

source

#### pub fn all(self) -> bool

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

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

source§

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

source

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

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

Choose lanes from two vectors.

For each lane in the mask, choose the corresponding lane from `true_values` if that lane mask is true, and `false_values` if that lane 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]);

Run
source

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

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

Choose lanes from two masks.

For each lane in the mask, choose the corresponding lane from `true_values` if that lane mask is true, and `false_values` if that lane 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]);

Run

## Trait Implementations§

source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `&` operator.
source§

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

Performs the `&` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `&` operator.
source§

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

Performs the `&` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `&` operator.
source§

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

Performs the `&` operation. Read more
source§

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

source§

#### fn bitand_assign(&mut self, rhs: bool)

Performs the `&=` operation. Read more
source§

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

source§

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

Performs the `&=` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
source§

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

source§

#### fn bitor_assign(&mut self, rhs: bool)

Performs the `|=` operation. Read more
source§

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

source§

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

Performs the `|=` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `^` operator.
source§

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

Performs the `^` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `^` operator.
source§

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

Performs the `^` operation. Read more
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `^` operator.
source§

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

Performs the `^` operation. Read more
source§

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

source§

#### fn bitxor_assign(&mut self, rhs: bool)

Performs the `^=` operation. Read more
source§

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

source§

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

Performs the `^=` operation. Read more
source§

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

source§

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

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
source§

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

source§

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

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

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

source§

#### fn default() -> Mask<T, LANES>

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

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

§

#### type Output = Mask<T, LANES>

The resulting type after applying the `!` operator.
source§

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

Performs the unary `!` operation. Read more
source§

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

source§

#### fn eq(&self, other: &Mask<T, LANES>) -> 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.
source§

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

source§

#### fn partial_cmp(&self, other: &Mask<T, LANES>) -> 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

This method 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

This method 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

This method 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

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise maximum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise minimum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Restrict each lane to a certain interval. Read more
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise maximum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise minimum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Restrict each lane to a certain interval. Read more
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise maximum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise minimum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Restrict each lane to a certain interval. Read more
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise maximum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise minimum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Restrict each lane to a certain interval. Read more
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise maximum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Returns the lane-wise minimum with `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Restrict each lane to a certain interval. Read more
source§

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

§

#### type Mask = Mask<i16, LANES>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The mask type returned by each comparison.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

§

#### type Mask = Mask<i32, LANES>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The mask type returned by each comparison.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

§

#### type Mask = Mask<i64, LANES>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The mask type returned by each comparison.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

§

#### type Mask = Mask<i8, LANES>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The mask type returned by each comparison.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

§

#### type Mask = Mask<isize, LANES>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The mask type returned by each comparison.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is equal to the corresponding lane in `other`.
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than or equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than or equal to the corresponding lane in `other`.
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than or equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than or equal to the corresponding lane in `other`.
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than or equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than or equal to the corresponding lane in `other`.
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than or equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than or equal to the corresponding lane in `other`.
source§

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

source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is less than or equal to the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than the corresponding lane in `other`.
source§

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

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Test if each lane is greater than or equal to the corresponding lane in `other`.
source§

### impl<T> ToBitMask for Mask<T, 1>where T: MaskElement,

§

#### type BitMask = u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u8) -> Mask<T, 1>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 16>where T: MaskElement,

§

#### type BitMask = u16

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u16

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u16) -> Mask<T, 16>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 2>where T: MaskElement,

§

#### type BitMask = u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u8) -> Mask<T, 2>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 32>where T: MaskElement,

§

#### type BitMask = u32

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u32

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u32) -> Mask<T, 32>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 4>where T: MaskElement,

§

#### type BitMask = u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u8) -> Mask<T, 4>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 64>where T: MaskElement,

§

#### type BitMask = u64

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u64

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u64) -> Mask<T, 64>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

### impl<T> ToBitMask for Mask<T, 8>where T: MaskElement,

§

#### type BitMask = u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
The integer bitmask type.
source§

#### fn to_bitmask(self) -> u8

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a mask to a bitmask.
source§

#### fn from_bitmask(bitmask: u8) -> Mask<T, 8>

🔬This is a nightly-only experimental API. (`portable_simd` #86656)
Converts a bitmask to a mask.
source§

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

## Auto Trait Implementations§

§

### impl<T, const LANES: usize> RefUnwindSafe for Mask<T, LANES>where T: RefUnwindSafe,

§

### impl<T, const LANES: usize> Send for Mask<T, LANES>where T: Send,

§

### impl<T, const LANES: usize> Sync for Mask<T, LANES>where T: Sync,

§

### impl<T, const LANES: usize> Unpin for Mask<T, LANES>where T: Unpin,

§

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

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. 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 Twhere 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<T> ToOwned for Twhere T: Clone,

§

#### 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 Twhere U: Into<T>,

§

#### type Error = Infallible

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

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### 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.