Struct open_cl_low_level::cl_bitflags::MemFlags

pub struct MemFlags { /* fields omitted */ }

Methods

impl MemFlags

pub const EMPTY: MemFlags

pub const KERNEL_READ_WRITE: MemFlags

pub const KERNEL_WRITE_ONLY: MemFlags

pub const KERNEL_READ_ONLY: MemFlags

pub const ALLOC_HOST_PTR: MemFlags

pub const USE_HOST_PTR: MemFlags

pub const COPY_HOST_PTR: MemFlags

pub const HOST_WRITE_ONLY: MemFlags

pub const HOST_READ_ONLY: MemFlags

pub const HOST_NO_ACCESS: MemFlags

pub const HOST_READ_WRITE: MemFlags

pub const READ_WRITE_ALLOC_HOST_PTR: MemFlags

pub const READ_ONLY_ALLOC_HOST_PTR: MemFlags

pub const WRITE_ONLY_ALLOC_HOST_PTR: MemFlags

pub const fn empty() -> MemFlags

Returns an empty set of flags

pub const fn all() -> MemFlags

Returns the set containing all flags.

pub const fn bits(&self) -> cl_mem_flags

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: cl_mem_flags) -> Option<MemFlags>

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

pub const fn from_bits_truncate(bits: cl_mem_flags) -> MemFlags

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

pub const unsafe fn from_bits_unchecked(bits: cl_mem_flags) -> MemFlags

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: MemFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for MemFlags

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

Formats the value using the given formatter.

impl BitAnd<MemFlags> for MemFlags

type Output = MemFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<MemFlags> for MemFlags

fn bitand_assign(&mut self, other: MemFlags)

Disables all flags disabled in the set.

impl BitOr<MemFlags> for MemFlags

type Output = MemFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<MemFlags> for MemFlags

fn bitor_assign(&mut self, other: MemFlags)

Adds the set of flags.

impl BitXor<MemFlags> for MemFlags

type Output = MemFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<MemFlags> for MemFlags

fn bitxor_assign(&mut self, other: MemFlags)

Toggles the set of flags.

impl Clone for MemFlags

fn clone(&self) -> MemFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MemFlags

impl Debug for MemFlags

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

Formats the value using the given formatter.

impl Eq for MemFlags

impl Extend<MemFlags> for MemFlags

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

Extends a collection with the contents of an iterator.

impl From<HostAccess> for MemFlags

fn from(host_access: HostAccess) -> MemFlags

Performs the conversion.

impl From<HostAccessMemFlags> for MemFlags

fn from(access: HostAccessMemFlags) -> MemFlags

Performs the conversion.

impl From<KernelAccess> for MemFlags

fn from(kernel_access: KernelAccess) -> MemFlags

Performs the conversion.

impl From<KernelAccessMemFlags> for MemFlags

fn from(access: KernelAccessMemFlags) -> MemFlags

Performs the conversion.

impl From<MemConfig> for MemFlags

fn from(mem_config: MemConfig) -> MemFlags

Performs the conversion.

impl From<MemFlags> for Option<HostAccessMemFlags>

fn from(mem_flags: MemFlags) -> Option<HostAccessMemFlags>

Performs the conversion.

impl From<MemFlags> for Option<KernelAccessMemFlags>

fn from(mem_flags: MemFlags) -> Option<KernelAccessMemFlags>

Performs the conversion.

impl From<MemFlags> for Option<MemLocationMemFlags>

fn from(mem_flags: MemFlags) -> Option<MemLocationMemFlags>

Performs the conversion.

impl From<MemFlags> for cl_mem_flags

fn from(d: MemFlags) -> cl_mem_flags

Performs the conversion.

impl From<MemLocation> for MemFlags

fn from(mem_location: MemLocation) -> MemFlags

Performs the conversion.

impl From<MemLocationMemFlags> for MemFlags

fn from(loc: MemLocationMemFlags) -> MemFlags

Performs the conversion.

impl FromIterator<MemFlags> for MemFlags

fn from_iter<T: IntoIterator<Item = MemFlags>>(iterator: T) -> MemFlags

Creates a value from an iterator.

impl Hash for MemFlags

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

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 LowerHex for MemFlags

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

Formats the value using the given formatter.

impl Not for MemFlags

type Output = MemFlags

The resulting type after applying the ! operator.

fn not(self) -> MemFlags

Returns the complement of this set of flags.

impl Octal for MemFlags

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

Formats the value using the given formatter.

impl Ord for MemFlags

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] 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<MemFlags> for MemFlags

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

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

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

This method tests for !=.

impl PartialOrd<MemFlags> for MemFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for MemFlags

impl StructuralPartialEq for MemFlags

impl Sub<MemFlags> for MemFlags

type Output = MemFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<MemFlags> for MemFlags

fn sub_assign(&mut self, other: MemFlags)

Disables all flags enabled in the set.

impl UpperHex for MemFlags

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

Formats the value using the given formatter.