Struct ocl::flags::MemFlags

pub struct MemFlags { /* fields omitted */ }

cl_mem_flags - bitfield

Methods

impl MemFlags

pub fn new() -> MemFlags

pub fn read_write(self) -> MemFlags

pub fn write_only(self) -> MemFlags

pub fn read_only(self) -> MemFlags

pub fn use_host_ptr(self) -> MemFlags

pub fn alloc_host_ptr(self) -> MemFlags

pub fn copy_host_ptr(self) -> MemFlags

pub fn host_write_only(self) -> MemFlags

pub fn host_read_only(self) -> MemFlags

pub fn host_no_access(self) -> MemFlags

impl MemFlags

pub const READ_WRITE: MemFlags

READ_WRITE: MemFlags = MemFlags{bits: 1 << 0,}

pub const WRITE_ONLY: MemFlags

WRITE_ONLY: MemFlags = MemFlags{bits: 1 << 1,}

pub const READ_ONLY: MemFlags

READ_ONLY: MemFlags = MemFlags{bits: 1 << 2,}

pub const USE_HOST_PTR: MemFlags

USE_HOST_PTR: MemFlags = MemFlags{bits: 1 << 3,}

pub const ALLOC_HOST_PTR: MemFlags

ALLOC_HOST_PTR: MemFlags = MemFlags{bits: 1 << 4,}

pub const COPY_HOST_PTR: MemFlags

COPY_HOST_PTR: MemFlags = MemFlags{bits: 1 << 5,}

pub const HOST_WRITE_ONLY: MemFlags

HOST_WRITE_ONLY: MemFlags = MemFlags{bits: 1 << 7,}

pub const HOST_READ_ONLY: MemFlags

HOST_READ_ONLY: MemFlags = MemFlags{bits: 1 << 8,}

pub const HOST_NO_ACCESS: MemFlags

HOST_NO_ACCESS: MemFlags = MemFlags{bits: 1 << 9,}

pub fn empty() -> MemFlags

Returns an empty set of flags.

pub fn all() -> MemFlags

Returns the set containing all flags.

pub fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

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

pub fn from_bits_truncate(bits: u64) -> MemFlags

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

Formats the value using the given formatter.

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

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

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.

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.

impl Default for MemFlags

fn default() -> MemFlags

Returns the "default value" for a type.

impl SubAssign<MemFlags> for MemFlags

fn sub_assign(&mut self, other: MemFlags)

Disables all flags enabled in the set.

impl BitAndAssign<MemFlags> for MemFlags

fn bitand_assign(&mut self, other: MemFlags)

Disables all flags disabled in the set.

impl BitXorAssign<MemFlags> for MemFlags

fn bitxor_assign(&mut self, other: MemFlags)

Toggles the set of flags.

impl BitOrAssign<MemFlags> for MemFlags

fn bitor_assign(&mut self, other: MemFlags)

Adds the set of flags.

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

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

Extends a collection with the contents of an iterator.

impl Hash for MemFlags

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

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

Formats the value using the given formatter.

impl Octal for MemFlags

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

Formats the value using the given formatter.

impl UpperHex for MemFlags

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

Formats the value using the given formatter.

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

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

Creates a value from an iterator.

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

impl Eq for MemFlags

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