Struct fil_ocl::flags::MapFlags

pub struct MapFlags { /* fields omitted */ }

cl_map_flags - bitfield

Methods

impl MapFlags

pub fn new() -> MapFlags

pub fn read(self) -> MapFlags

pub fn write(self) -> MapFlags

pub fn write_invalidate_region(self) -> MapFlags

impl MapFlags

pub const READ: MapFlags

pub const WRITE: MapFlags

pub const WRITE_INVALIDATE_REGION: MapFlags

pub const fn empty() -> MapFlags

Returns an empty set of flags

pub const fn all() -> MapFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<MapFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u64) -> MapFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> MapFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: MapFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: MapFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: MapFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: MapFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: MapFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: MapFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl PartialOrd<MapFlags> for MapFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Default for MapFlags

fn default() -> MapFlags

Returns the "default value" for a type.

impl UpperHex for MapFlags

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

Formats the value using the given formatter.

impl FromIterator<MapFlags> for MapFlags

fn from_iter<T>(iterator: T) -> MapFlags where
    T: IntoIterator<Item = MapFlags>, 

Creates a value from an iterator.

impl StructuralPartialEq for MapFlags

impl LowerHex for MapFlags

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

Formats the value using the given formatter.

impl StructuralEq for MapFlags

impl BitXor<MapFlags> for MapFlags

type Output = MapFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: MapFlags) -> MapFlags

Returns the left flags, but with all the right flags toggled.

impl BitAnd<MapFlags> for MapFlags

type Output = MapFlags

The resulting type after applying the & operator.

fn bitand(self, other: MapFlags) -> MapFlags

Returns the intersection between the two sets of flags.

impl Not for MapFlags

type Output = MapFlags

The resulting type after applying the ! operator.

fn not(self) -> MapFlags

Returns the complement of this set of flags.

impl Copy for MapFlags

impl BitOrAssign<MapFlags> for MapFlags

fn bitor_assign(&mut self, other: MapFlags)

Adds the set of flags.

impl BitAndAssign<MapFlags> for MapFlags

fn bitand_assign(&mut self, other: MapFlags)

Disables all flags disabled in the set.

impl Clone for MapFlags

fn clone(&self) -> MapFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sub<MapFlags> for MapFlags

type Output = MapFlags

The resulting type after applying the - operator.

fn sub(self, other: MapFlags) -> MapFlags

Returns the set difference of the two sets of flags.

impl Debug for MapFlags

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

Formats the value using the given formatter.

impl Ord for MapFlags

fn cmp(&self, other: &MapFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<MapFlags> for MapFlags

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

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

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

This method tests for !=.

impl Extend<MapFlags> for MapFlags

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = MapFlags>, 

Extends a collection with the contents of an iterator.

impl Eq for MapFlags

impl Octal for MapFlags

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

Formats the value using the given formatter.

impl Binary for MapFlags

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

Formats the value using the given formatter.

impl BitXorAssign<MapFlags> for MapFlags

fn bitxor_assign(&mut self, other: MapFlags)

Toggles the set of flags.

impl Hash for MapFlags

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl SubAssign<MapFlags> for MapFlags

fn sub_assign(&mut self, other: MapFlags)

Disables all flags enabled in the set.

impl BitOr<MapFlags> for MapFlags

type Output = MapFlags

The resulting type after applying the | operator.

fn bitor(self, other: MapFlags) -> MapFlags

Returns the union of the two sets of flags.