Struct Mask16x1

pub struct Mask16x1(/* private fields */);

SIMD vector mask suitable for (1) 16-bit element(s).

For a given SIMD vector with elements of some width, the equivalent mask type can be described as another SIMD vector of equivalently-wide, signed integers. That is, for example, for an f32x6 vector, the appropriate mask vector type would be i32x6.

Implementations

impl Mask16x1

pub const fn from_bitmask(mask: [bool; 1]) -> Self

Constructs a SIMD mask from a bitmask.

pub const fn from_int(value: i16x1) -> Self

Constructs a SIMD mask from a SIMD vector.

See from_int_unchecked for this operation without checks.

Panics

All values of the SIMD vector must either be 0 (mask does not apply) or -1 (mask applies). If this is not the case, then this constructor will panic.

pub const unsafe fn from_int_unchecked(value: i16x1) -> Self

Constructs a SIMD mask from a SIMD vector.

See from_int for a safe variant of this function.

Safety

All values of the SIMD vector must either be 0 (mask does not apply) or -1 (mask applies). Behaviour is undefined if this is not the case.

pub const fn to_bitmask(self) -> [bool; 1]

Converts the SIMD mask into a bitmask.

For each value in the initial mask, 0 values are converted to false and -1 values are converted to true.

pub const fn to_int(self) -> i16x1

Converts the SIMD mask into a SIMD vector.

For each element of the returned vector, 0 denotes an index that the mask applies to and -1 denotes an index that the mask does not apply to.

Trait Implementations

impl Clone for Mask16x1

fn clone(&self) -> Mask16x1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mask16x1

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

Formats the value using the given formatter.

impl Default for Mask16x1

fn default() -> Mask16x1

Returns the “default value” for a type.

impl From<[bool; 1]> for Mask16x1

fn from(value: [bool; 1]) -> Self

See from_bitmask.

impl FromBytes for Mask16x1

where i16x1: FromBytes,

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

fn read_from_io<R>(src: R) -> Result<Self, Error>

where Self: Sized, R: Read,

Reads a copy of self from an io::Read.

impl FromZeros for Mask16x1

where i16x1: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Result<Vec<Self>, AllocError>

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl IntoBytes for Mask16x1

where i16x1: IntoBytes,

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

impl KnownLayout for Mask16x1

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl PartialEq for Mask16x1

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

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

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 PartialOrd for Mask16x1

fn partial_cmp(&self, other: &Mask16x1) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl TryFromBytes for Mask16x1

where i16x1: TryFromBytes,

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Zeroable for Mask16x1

fn zeroed() -> Self

Calls zeroed.

impl Copy for Mask16x1

impl Eq for Mask16x1

impl Pod for Mask16x1

impl StructuralPartialEq for Mask16x1