Struct CVec

Source

pub struct CVec<T> { /* private fields */ }

Expand description

The type representing a foreign mutable chunk of memory.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };

Implementations§

Source §

impl<T> CVec<T>

Source

pub unsafe fn new(base: *mut T, len: usize) -> CVec<T>

Create a CVec from a raw pointer to a buffer with a given length.

Panics if the given pointer is null. The returned vector will not attempt to deallocate the vector when dropped.

§Arguments

base - A unique pointer to a buffer
len - The number of elements in the buffer

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };

Source

pub unsafe fn new_with_dtor<F>(base: mut T, len: usize, dtor: F) -> CVec<T>
where F: FnOnce(mut T) + 'static,

Create a CVec from a foreign buffer, with a given length, and a function to run upon destruction.

Panics if the given pointer is null.

§Arguments

base - A unique pointer to a buffer
len - The number of elements in the buffer
dtor - A fn to run when the value is destructed, useful for freeing the buffer, etc. base will be passed to it as an argument.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new_with_dtor(ptr, slice.len(), |_| println!("free time!")) };

Source

pub fn get(&self, ofs: usize) -> Option<&T>

Retrieves an element at a given index, returning None if the requested index is greater than the length of the vector.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
assert_eq!(cvec.get(1), slice.get(1));

Source

pub unsafe fn get_unchecked(&self, ofs: usize) -> &T

Returns a reference to an element without doing any check.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
unsafe {
    assert_eq!(cvec.get_unchecked(1), slice.get_unchecked(1));
}

Source

pub fn get_mut(&mut self, ofs: usize) -> Option<&mut T>

Retrieves a mutable element at a given index, returning None if the requested index is greater than the length of the vector.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let mut cvec = unsafe { CVec::new(ptr, slice.len()) };
if let Some(el) = cvec.get_mut(1) {
    *el += 10;
}
assert_eq!(cvec[1], 11);

Source

pub unsafe fn get_unchecked_mut<'a>(&'a mut self, ofs: usize) -> &mut T

Returns a mutable reference to an element without doing any check.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let mut cvec = unsafe { CVec::new(ptr, slice.len()) };
unsafe { *cvec.get_unchecked_mut(1) += 10; }
assert_eq!(cvec[1], 11);

Source

pub unsafe fn into_inner(self) -> *mut T

Unwrap the pointer without running the destructor

This method retrieves the underlying pointer, and in the process destroys the CVec but without running the destructor. A use case would be transferring ownership of the buffer to a C function, as in this case you would not want to run the destructor.

Note that if you want to access the underlying pointer without cancelling the destructor, you can simply call transmute on the return value of CVec::get(0).

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
assert_eq!(unsafe { cvec.into_inner() }, ptr);

Source

pub fn len(&self) -> usize

Returns the number of items in this vector.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
assert_eq!(cvec.len(), slice.len());

Source

pub fn is_empty(&self) -> bool

Returns whether this vector is empty.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
assert_eq!(cvec.is_empty(), slice.is_empty());

Source

pub fn as_cslice<'a>(&'a self) -> CSlice<'a, T>

Returns a CSlice which is a “view” over the data.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
let cslice = cvec.as_cslice();

Source

pub fn as_cslice_mut<'a>(&'a mut self) -> CSliceMut<'a, T>

Returns a CSliceMut which is a mutable “view” over the data.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let mut cvec = unsafe { CVec::new(ptr, slice.len()) };
let cslice = cvec.as_cslice_mut();

Source

pub fn iter<'a>(&'a self) -> CVecIter<'a, T> ⓘ

Returns an iterator over CVec data.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let cvec = unsafe { CVec::new(ptr, slice.len()) };
for elem in cvec.iter() {
    println!("=> {}", elem);
}

Source

pub fn iter_mut<'a>(&'a mut self) -> CVecIterMut<'a, T> ⓘ

Returns a mutable iterator over CVec data.

§Example

use c_vec::CVec;

let slice = &mut [0, 1, 2];
let ptr = slice.as_mut_ptr();
let mut cvec = unsafe { CVec::new(ptr, slice.len()) };
for elem in cvec.iter_mut() {
    *elem += 1;
}
assert_eq!(cvec[0], 1);