Struct ocl::EventList

pub struct EventList { /* fields omitted */ }

A list of events for coordinating enqueued commands.

Events contain status information about the command that created them. Used to coordinate the activity of multiple commands with more fine-grained control than the queue alone.

For access to individual events use get_clone and last_clone then either store or discard the result.

EventList is a dynamically allocated list. It will be (internally) stack allocated (as an [Event; 8]) until it reaches a length of 9 at which time it will become heap-allocated (a Vec<Event>).

At the time of this writing, converting back from heap to stack allocation is not implemented but a bit of prodding (by filing an issue) would probably work to remedy that if anyone thinks it useful.

Methods

impl EventList

fn new() -> EventList

Returns a new, empty, stack-allocated EventList.

fn with_capacity(cap: usize) -> EventList

Returns a new, empty, EventListwith an initial capacity ofcap`.

If cap is greater than 8, the event list will be heap-allocated.

fn push<E: Into<Event>>(&mut self, event: E)

Adds an event to the list.

fn push_some<E: Into<Event>>(&mut self, event: Option<E>)

Pushes an Option<Event> to the list if it is Some(...).

fn pop(&mut self) -> Option<Event>

Removes the last event from the list and returns it.

fn clear(&mut self)

Clears all events from the list whether or not they have completed.

Forwards any errors related to releasing events.

fn clear_completed(&mut self) -> OclResult<()>

Clears events which have completed.

fn wait_for(&self) -> OclResult<()>

Blocks the host thread until all events in this list are complete.

fn enqueue_marker(&self, queue: &Queue) -> OclResult<Event>

Enqueue a marker event representing the completion of each and every event in this list.

Platform Compatibility

Some device/platform combinations (particularly older Intel CPUs on Intel platform drivers) may have intermittent issues waiting on markers when multiple threads are in use. This is rare and can be circumvented by using AMD platform drivers instead. Please file an issue immediately if you run into problems on your platform so that we may make note of it here in the documentation.

fn as_slice(&self) -> &[Event]

Returns a slice of the contained events.

fn as_mut_slice(&mut self) -> &mut [Event]

Returns a mutable slice of the contained events.

Methods from Deref<Target = [Event]>

fn len(&self) -> usize

Returns the number of elements in the slice.

Example

let a = [1, 2, 3];
assert_eq!(a.len(), 3);

fn is_empty(&self) -> bool

Returns true if the slice has a length of 0.

Example

let a = [1, 2, 3];
assert!(!a.is_empty());

fn first(&self) -> Option<&T>

Returns the first element of the slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&10), v.first());

let w: &[i32] = &[];
assert_eq!(None, w.first());

fn first_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the first element of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

if let Some(first) = x.first_mut() {
    *first = 5;
}
assert_eq!(x, &[5, 1, 2]);

fn split_first(&self) -> Option<(&T, &[T])>

Returns the first and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &[0, 1, 2];

if let Some((first, elements)) = x.split_first() {
    assert_eq!(first, &0);
    assert_eq!(elements, &[1, 2]);
}

fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the first and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

if let Some((first, elements)) = x.split_first_mut() {
    *first = 3;
    elements[0] = 4;
    elements[1] = 5;
}
assert_eq!(x, &[3, 4, 5]);

fn split_last(&self) -> Option<(&T, &[T])>

Returns the last and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &[0, 1, 2];

if let Some((last, elements)) = x.split_last() {
    assert_eq!(last, &2);
    assert_eq!(elements, &[0, 1]);
}

fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the last and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

if let Some((last, elements)) = x.split_last_mut() {
    *last = 3;
    elements[0] = 4;
    elements[1] = 5;
}
assert_eq!(x, &[4, 5, 3]);

fn last(&self) -> Option<&T>

Returns the last element of the slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&30), v.last());

let w: &[i32] = &[];
assert_eq!(None, w.last());

fn last_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the last item in the slice.

Examples

let x = &mut [0, 1, 2];

if let Some(last) = x.last_mut() {
    *last = 10;
}
assert_eq!(x, &[0, 1, 10]);

fn get<I>(&self, index: I) -> Option<&I::Output> where
    I: SliceIndex<[T]>, 

Returns a reference to an element or subslice depending on the type of index.

• If given a position, returns a reference to the element at that position or None if out of bounds.
• If given a range, returns the subslice corresponding to that range, or None if out of bounds.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&40), v.get(1));
assert_eq!(Some(&[10, 40][..]), v.get(0..2));
assert_eq!(None, v.get(3));
assert_eq!(None, v.get(0..4));

fn get_mut<I>(&mut self, index: I) -> Option<&mut I::Output> where
    I: SliceIndex<[T]>, 

Returns a mutable reference to an element or subslice depending on the type of index (see get) or None if the index is out of bounds.

Examples

let x = &mut [0, 1, 2];

if let Some(elem) = x.get_mut(1) {
    *elem = 42;
}
assert_eq!(x, &[0, 42, 2]);

unsafe fn get_unchecked<I>(&self, index: I) -> &I::Output where
    I: SliceIndex<[T]>, 

Returns a reference to an element or subslice, without doing bounds checking. So use it very carefully!

Examples

let x = &[1, 2, 4];

unsafe {
    assert_eq!(x.get_unchecked(1), &2);
}

unsafe fn get_unchecked_mut<I>(&mut self, index: I) -> &mut I::Output where
    I: SliceIndex<[T]>, 

Returns a mutable reference to an element or subslice, without doing bounds checking. So use it very carefully!

Examples

let x = &mut [1, 2, 4];

unsafe {
    let elem = x.get_unchecked_mut(1);
    *elem = 13;
}
assert_eq!(x, &[1, 13, 4]);

fn as_ptr(&self) -> *const T

Returns a raw pointer to the slice's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

let x = &[1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(x.get_unchecked(i), &*x_ptr.offset(i as isize));
    }
}

fn as_mut_ptr(&mut self) -> *mut T

Returns an unsafe mutable pointer to the slice's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

let x = &mut [1, 2, 4];
let x_ptr = x.as_mut_ptr();

unsafe {
    for i in 0..x.len() {
        *x_ptr.offset(i as isize) += 2;
    }
}
assert_eq!(x, &[3, 4, 6]);

fn swap(&mut self, a: usize, b: usize)

Swaps two elements in the slice.

Arguments

• a - The index of the first element
• b - The index of the second element

Panics

Panics if a or b are out of bounds.

Examples

let mut v = ["a", "b", "c", "d"];
v.swap(1, 3);
assert!(v == ["a", "d", "c", "b"]);

fn reverse(&mut self)

Reverses the order of elements in the slice, in place.

Example

let mut v = [1, 2, 3];
v.reverse();
assert!(v == [3, 2, 1]);

fn iter(&self) -> Iter<T>

Returns an iterator over the slice.

Examples

let x = &[1, 2, 4];
let mut iterator = x.iter();

assert_eq!(iterator.next(), Some(&1));
assert_eq!(iterator.next(), Some(&2));
assert_eq!(iterator.next(), Some(&4));
assert_eq!(iterator.next(), None);

fn iter_mut(&mut self) -> IterMut<T>

Returns an iterator that allows modifying each value.

Examples

let x = &mut [1, 2, 4];
for elem in x.iter_mut() {
    *elem += 2;
}
assert_eq!(x, &[3, 4, 6]);

fn windows(&self, size: usize) -> Windows<T>

Returns an iterator over all contiguous windows of length size. The windows overlap. If the slice is shorter than size, the iterator returns no values.

Panics

Panics if size is 0.

Example

let slice = ['r', 'u', 's', 't'];
let mut iter = slice.windows(2);
assert_eq!(iter.next().unwrap(), &['r', 'u']);
assert_eq!(iter.next().unwrap(), &['u', 's']);
assert_eq!(iter.next().unwrap(), &['s', 't']);
assert!(iter.next().is_none());

If the slice is shorter than size:

let slice = ['f', 'o', 'o'];
let mut iter = slice.windows(4);
assert!(iter.next().is_none());

fn chunks(&self, size: usize) -> Chunks<T>

Returns an iterator over size elements of the slice at a time. The chunks are slices and do not overlap. If size does not divide the length of the slice, then the last chunk will not have length size.

Panics

Panics if size is 0.

Example

let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.chunks(2);
assert_eq!(iter.next().unwrap(), &['l', 'o']);
assert_eq!(iter.next().unwrap(), &['r', 'e']);
assert_eq!(iter.next().unwrap(), &['m']);
assert!(iter.next().is_none());

fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T>

Returns an iterator over chunk_size elements of the slice at a time. The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

Panics

Panics if chunk_size is 0.

Examples

let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.chunks_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[1, 1, 2, 2, 3]);

fn split_at(&self, mid: usize) -> (&[T], &[T])

Divides one slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Examples

let v = [10, 40, 30, 20, 50];
let (v1, v2) = v.split_at(2);
assert_eq!([10, 40], v1);
assert_eq!([30, 20, 50], v2);

fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T])

Divides one &mut into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Examples

let mut v = [1, 2, 3, 4, 5, 6];

// scoped to restrict the lifetime of the borrows
{
   let (left, right) = v.split_at_mut(0);
   assert!(left == []);
   assert!(right == [1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at_mut(2);
    assert!(left == [1, 2]);
    assert!(right == [3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at_mut(6);
    assert!(left == [1, 2, 3, 4, 5, 6]);
    assert!(right == []);
}

fn split<F>(&self, pred: F) -> Split<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred. The matched element is not contained in the subslices.

Examples

let slice = [10, 40, 33, 20];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10, 40]);
assert_eq!(iter.next().unwrap(), &[20]);
assert!(iter.next().is_none());

If the first element is matched, an empty slice will be the first item returned by the iterator. Similarly, if the last element in the slice is matched, an empty slice will be the last item returned by the iterator:

let slice = [10, 40, 33];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10, 40]);
assert_eq!(iter.next().unwrap(), &[]);
assert!(iter.next().is_none());

If two matched elements are directly adjacent, an empty slice will be present between them:

let slice = [10, 6, 33, 20];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10]);
assert_eq!(iter.next().unwrap(), &[]);
assert_eq!(iter.next().unwrap(), &[20]);
assert!(iter.next().is_none());

fn split_mut<F>(&mut self, pred: F) -> SplitMut<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over mutable subslices separated by elements that match pred. The matched element is not contained in the subslices.

Examples

let mut v = [10, 40, 30, 20, 60, 50];

for group in v.split_mut(|num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(v, [1, 40, 30, 1, 60, 1]);

fn rsplit<F>(&self, pred: F) -> RSplit<T, F> where
    F: FnMut(&T) -> bool, 

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

Returns an iterator over subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

Examples

#![feature(slice_rsplit)]

let slice = [11, 22, 33, 0, 44, 55];
let mut iter = slice.rsplit(|num| *num == 0);

assert_eq!(iter.next().unwrap(), &[44, 55]);
assert_eq!(iter.next().unwrap(), &[11, 22, 33]);
assert_eq!(iter.next(), None);

As with split(), if the first or last element is matched, an empty slice will be the first (or last) item returned by the iterator.

#![feature(slice_rsplit)]

let v = &[0, 1, 1, 2, 3, 5, 8];
let mut it = v.rsplit(|n| *n % 2 == 0);
assert_eq!(it.next().unwrap(), &[]);
assert_eq!(it.next().unwrap(), &[3, 5]);
assert_eq!(it.next().unwrap(), &[1, 1]);
assert_eq!(it.next().unwrap(), &[]);
assert_eq!(it.next(), None);

fn rsplit_mut<F>(&mut self, pred: F) -> RSplitMut<T, F> where
    F: FnMut(&T) -> bool, 

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

Returns an iterator over mutable subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

Examples

#![feature(slice_rsplit)]

let mut v = [100, 400, 300, 200, 600, 500];

let mut count = 0;
for group in v.rsplit_mut(|num| *num % 3 == 0) {
    count += 1;
    group[0] = count;
}
assert_eq!(v, [3, 400, 300, 2, 600, 1]);

fn splitn<F>(&self, n: usize, pred: F) -> SplitN<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once by numbers divisible by 3 (i.e. [10, 40], [20, 60, 50]):

let v = [10, 40, 30, 20, 60, 50];

for group in v.splitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

let mut v = [10, 40, 30, 20, 60, 50];

for group in v.splitn_mut(2, |num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(v, [1, 40, 30, 1, 60, 50]);

fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once, starting from the end, by numbers divisible by 3 (i.e. [50], [10, 40, 30, 20]):

let v = [10, 40, 30, 20, 60, 50];

for group in v.rsplitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

let mut s = [10, 40, 30, 20, 60, 50];

for group in s.rsplitn_mut(2, |num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(s, [1, 40, 30, 20, 60, 1]);

fn contains(&self, x: &T) -> bool where
    T: PartialEq<T>, 

Returns true if the slice contains an element with the given value.

Examples

let v = [10, 40, 30];
assert!(v.contains(&30));
assert!(!v.contains(&50));

fn starts_with(&self, needle: &[T]) -> bool where
    T: PartialEq<T>, 

Returns true if needle is a prefix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.starts_with(&[10]));
assert!(v.starts_with(&[10, 40]));
assert!(!v.starts_with(&[50]));
assert!(!v.starts_with(&[10, 50]));

Always returns true if needle is an empty slice:

let v = &[10, 40, 30];
assert!(v.starts_with(&[]));
let v: &[u8] = &[];
assert!(v.starts_with(&[]));

fn ends_with(&self, needle: &[T]) -> bool where
    T: PartialEq<T>, 

Returns true if needle is a suffix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.ends_with(&[30]));
assert!(v.ends_with(&[40, 30]));
assert!(!v.ends_with(&[50]));
assert!(!v.ends_with(&[50, 30]));

Always returns true if needle is an empty slice:

let v = &[10, 40, 30];
assert!(v.ends_with(&[]));
let v: &[u8] = &[];
assert!(v.ends_with(&[]));

fn binary_search(&self, x: &T) -> Result<usize, usize> where
    T: Ord, 

Binary searches this sorted slice for a given element.

If the value is found then Ok is returned, containing the index of the matching element; if the value is not found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Example

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

assert_eq!(s.binary_search(&13),  Ok(9));
assert_eq!(s.binary_search(&4),   Err(7));
assert_eq!(s.binary_search(&100), Err(13));
let r = s.binary_search(&1);
assert!(match r { Ok(1...4) => true, _ => false, });

fn binary_search_by<'a, F>(&'a self, f: F) -> Result<usize, usize> where
    F: FnMut(&'a T) -> Ordering, 

Binary searches this sorted slice with a comparator function.

The comparator function should implement an order consistent with the sort order of the underlying slice, returning an order code that indicates whether its argument is Less, Equal or Greater the desired target.

If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Example

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

let seek = 13;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
let seek = 4;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
let seek = 100;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
let seek = 1;
let r = s.binary_search_by(|probe| probe.cmp(&seek));
assert!(match r { Ok(1...4) => true, _ => false, });

fn binary_search_by_key<'a, B, F>(&'a self, b: &B, f: F) -> Result<usize, usize> where
    B: Ord,
    F: FnMut(&'a T) -> B, 

Binary searches this sorted slice with a key extraction function.

Assumes that the slice is sorted by the key, for instance with sort_by_key using the same key extraction function.

If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Examples

Looks up a series of four elements in a slice of pairs sorted by their second elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
         (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
         (1, 21), (2, 34), (4, 55)];

assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b),  Ok(9));
assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b),   Err(7));
assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13));
let r = s.binary_search_by_key(&1, |&(a,b)| b);
assert!(match r { Ok(1...4) => true, _ => false, });

fn sort(&mut self) where
    T: Ord, 

Sorts the slice.

This sort is stable (i.e. does not reorder equal elements) and O(n log n) worst-case.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [-5, 4, 1, -3, 2];

v.sort();
assert!(v == [-5, -3, 1, 2, 4]);

fn sort_by<F>(&mut self, compare: F) where
    F: FnMut(&T, &T) -> Ordering, 

Sorts the slice with a comparator function.

This sort is stable (i.e. does not reorder equal elements) and O(n log n) worst-case.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [5, 4, 1, 3, 2];
v.sort_by(|a, b| a.cmp(b));
assert!(v == [1, 2, 3, 4, 5]);

// reverse sorting
v.sort_by(|a, b| b.cmp(a));
assert!(v == [5, 4, 3, 2, 1]);

fn sort_by_key<B, F>(&mut self, f: F) where
    B: Ord,
    F: FnMut(&T) -> B, 

Sorts the slice with a key extraction function.

This sort is stable (i.e. does not reorder equal elements) and O(n log n) worst-case.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

v.sort_by_key(|k| k.abs());
assert!(v == [1, 2, -3, 4, -5]);

fn sort_unstable(&mut self) where
    T: Ord, 

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

Sorts the slice, but may not preserve the order of equal elements.

This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate), and O(n log n) worst-case.

Current implementation

The current algorithm is based on Orson Peters' pattern-defeating quicksort, which is a quicksort variant designed to be very fast on certain kinds of patterns, sometimes achieving linear time. It is randomized but deterministic, and falls back to heapsort on degenerate inputs.

It is generally faster than stable sorting, except in a few special cases, e.g. when the slice consists of several concatenated sorted sequences.

Examples

#![feature(sort_unstable)]

let mut v = [-5, 4, 1, -3, 2];

v.sort_unstable();
assert!(v == [-5, -3, 1, 2, 4]);

fn sort_unstable_by<F>(&mut self, compare: F) where
    F: FnMut(&T, &T) -> Ordering, 

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

Sorts the slice with a comparator function, but may not preserve the order of equal elements.

This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate), and O(n log n) worst-case.

Current implementation

The current algorithm is based on Orson Peters' pattern-defeating quicksort, which is a quicksort variant designed to be very fast on certain kinds of patterns, sometimes achieving linear time. It is randomized but deterministic, and falls back to heapsort on degenerate inputs.

It is generally faster than stable sorting, except in a few special cases, e.g. when the slice consists of several concatenated sorted sequences.

Examples

#![feature(sort_unstable)]

let mut v = [5, 4, 1, 3, 2];
v.sort_unstable_by(|a, b| a.cmp(b));
assert!(v == [1, 2, 3, 4, 5]);

// reverse sorting
v.sort_unstable_by(|a, b| b.cmp(a));
assert!(v == [5, 4, 3, 2, 1]);

fn sort_unstable_by_key<B, F>(&mut self, f: F) where
    B: Ord,
    F: FnMut(&T) -> B, 

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

Sorts the slice with a key extraction function, but may not preserve the order of equal elements.

This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate), and O(n log n) worst-case.

Current implementation

The current algorithm is based on Orson Peters' pattern-defeating quicksort, which is a quicksort variant designed to be very fast on certain kinds of patterns, sometimes achieving linear time. It is randomized but deterministic, and falls back to heapsort on degenerate inputs.

It is generally faster than stable sorting, except in a few special cases, e.g. when the slice consists of several concatenated sorted sequences.

Examples

#![feature(sort_unstable)]

let mut v = [-5i32, 4, 1, -3, 2];

v.sort_unstable_by_key(|k| k.abs());
assert!(v == [1, 2, -3, 4, -5]);

fn clone_from_slice(&mut self, src: &[T]) where
    T: Clone, 

Copies the elements from src into self.

The length of src must be the same as self.

Panics

This function will panic if the two slices have different lengths.

Example

let mut dst = [0, 0, 0];
let src = [1, 2, 3];

dst.clone_from_slice(&src);
assert!(dst == [1, 2, 3]);

fn copy_from_slice(&mut self, src: &[T]) where
    T: Copy, 

Copies all elements from src into self, using a memcpy.

The length of src must be the same as self.

Panics

This function will panic if the two slices have different lengths.

Example

let mut dst = [0, 0, 0];
let src = [1, 2, 3];

dst.copy_from_slice(&src);
assert_eq!(src, dst);

fn to_vec(&self) -> Vec<T> where
    T: Clone, 

Copies self into a new Vec.

Examples

let s = [10, 40, 30];
let x = s.to_vec();
// Here, `s` and `x` can be modified independently.

fn into_vec(self: Box<[T]>) -> Vec<T>

Converts self into a vector without clones or allocation.

Examples

let s: Box<[i32]> = Box::new([10, 40, 30]);
let x = s.into_vec();
// `s` cannot be used anymore because it has been converted into `x`.

assert_eq!(x, vec![10, 40, 30]);

Trait Implementations

impl Debug for EventList

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

Formats the value using the given formatter.

impl Clone for EventList

fn clone(&self) -> EventList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, E> From<E> for EventList where
    E: Into<Event>, 

fn from(event: E) -> EventList

Performs the conversion.

impl<'a, E> From<&'a E> for EventList where
    E: Into<Event> + Clone, 

fn from(event: &E) -> EventList

Performs the conversion.

impl<'a> From<Vec<Event>> for EventList

fn from(events: Vec<Event>) -> EventList

Performs the conversion.

impl<'a, E> From<&'a Option<E>> for EventList where
    E: Into<Event> + Clone, 

fn from(event: &Option<E>) -> EventList

Performs the conversion.

impl<'a, 'b, E> From<Option<&'b E>> for EventList where
    'b: 'a,
    E: Into<Event> + Clone, 

fn from(event: Option<&E>) -> EventList

Performs the conversion.

impl<'a, 'b, E> From<&'a Option<&'b E>> for EventList where
    'b: 'a,
    E: Into<Event> + Clone, 

fn from(event: &Option<&E>) -> EventList

Performs the conversion.

impl<'a, E> From<&'a [E]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: &[E]) -> EventList

Performs the conversion.

impl<'a, E> From<&'a [Option<E>]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: &[Option<E>]) -> EventList

Performs the conversion.

impl<'a, 'b, E> From<&'a [Option<&'b E>]> for EventList where
    'b: 'a,
    E: Into<Event> + Clone, 

fn from(events: &[Option<&E>]) -> EventList

Performs the conversion.

impl<'a, 'b, E> From<&'a [&'b Option<E>]> for EventList where
    'b: 'a,
    E: Into<Event> + Clone, 

fn from(events: &[&Option<E>]) -> EventList

Performs the conversion.

impl<'a, 'b, 'c, E> From<&'a [&'b Option<&'c E>]> for EventList where
    'c: 'b,
    'b: 'a,
    E: Into<Event> + Clone, 

fn from(events: &[&Option<&E>]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 1]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 1]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 1]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 1]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 1]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 1]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 1]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 1]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 1]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 1]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 2]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 2]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 2]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 2]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 2]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 2]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 2]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 2]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 2]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 2]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 3]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 3]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 3]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 3]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 3]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 3]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 3]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 3]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 3]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 3]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 4]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 4]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 4]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 4]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 4]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 4]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 4]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 4]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 4]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 4]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 5]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 5]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 5]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 5]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 5]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 5]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 5]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 5]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 5]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 5]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 6]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 6]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 6]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 6]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 6]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 6]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 6]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 6]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 6]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 6]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 7]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 7]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 7]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 7]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 7]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 7]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 7]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 7]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 7]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 7]) -> EventList

Performs the conversion.

impl<'e, E> From<[E; 8]> for EventList where
    E: Into<Event>, 

fn from(events: [E; 8]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<E>; 8]> for EventList where
    E: Into<Event>, 

fn from(events: [Option<E>; 8]) -> EventList

Performs the conversion.

impl<'e, E> From<[Option<&'e E>; 8]> for EventList where
    E: Into<Event> + Clone, 

fn from(events: [Option<&E>; 8]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<E>; 8]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<E>; 8]) -> EventList

Performs the conversion.

impl<'e, 'f, E> From<[&'f Option<&'e E>; 8]> for EventList where
    'e: 'f,
    E: Into<Event> + Clone, 

fn from(events: [&'f Option<&'e E>; 8]) -> EventList

Performs the conversion.

impl<'a> From<&'a [cl_event]> for EventList

fn from(raw_events: &[cl_event]) -> EventList

Performs the conversion.

impl<'a> From<EventArray> for EventList

fn from(events: EventArray) -> EventList

Performs the conversion.

impl<'a> From<RawEventArray> for EventList

fn from(raw_events: RawEventArray) -> EventList

Performs the conversion.

impl<'a> From<Box<ClWaitListPtr>> for EventList

fn from(trait_obj: Box<ClWaitListPtr>) -> EventList

Performs the conversion.

impl<'a> From<&'a Box<ClWaitListPtr>> for EventList

fn from(trait_obj: &Box<ClWaitListPtr>) -> EventList

Performs the conversion.

impl<'a> From<Ref<'a, ClWaitListPtr>> for EventList

fn from(trait_obj: Ref<'a, ClWaitListPtr>) -> EventList

Performs the conversion.

impl<'a> From<ClWaitListPtrEnum<'a>> for EventList

fn from(wlpe: ClWaitListPtrEnum<'a>) -> EventList

Returns an EventList containing owned copies of each element in this ClWaitListPtrEnum.

impl Deref for EventList

type Target = [Event]

The resulting type after dereferencing

fn deref(&self) -> &[Event]

The method called to dereference a value

impl DerefMut for EventList

fn deref_mut(&mut self) -> &mut [Event]

The method called to mutably dereference a value

impl IntoIterator for EventList

type Item = Event

The type of the elements being iterated over.

type IntoIter = IntoIter<Event>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Future for EventList

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = OclError

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Removes (pops) each event from this list and waits for it to complete, dropping it in the process.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn boxed(
    self
) -> Box<Future<Error = Self::Error, Item = Self::Item> + 'static + Send> where
    Self: Send + 'static, 

Convenience function for turning this future into a trait object which is also Send.

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, B::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, B::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, B::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, B::Future, C::Future, D::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    Self::Item::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    Self::Item::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.

impl<'a> ClNullEventPtr for &'a mut EventList

fn alloc_new(&mut self) -> *mut cl_event

unsafe fn clone_from<E: AsRef<EventCore>>(&mut self, ev: E)

impl ClWaitListPtr for EventList

unsafe fn as_ptr_ptr(&self) -> *const cl_event

Returns a pointer to the first pointer in this list.

fn count(&self) -> u32

Returns the number of items in this wait list.

impl<'a> ClWaitListPtr for &'a EventList

unsafe fn as_ptr_ptr(&self) -> *const cl_event

Returns a pointer to the first pointer in this list.

fn count(&self) -> u32

Returns the number of items in this wait list.