1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
// Copyright 2012 The Rust Project Developers. // Copyright 2015 Guillaume Gomez // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. use std::marker::PhantomData; use std::ops::{Index, IndexMut}; use std::slice; use crate::{CSlice, CSliceMut}; /// Iterator over [`CVec`]. /// /// You can get it from the [`CVec::iter`] method. /// /// # 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 iter = cvec.iter(); /// ``` pub struct CVecIter<'a, T: 'a> { inner: &'a CVec<T>, pos: usize, } impl<'a, T> Iterator for CVecIter<'a, T> { type Item = &'a T; fn next(&mut self) -> Option<Self::Item> { if self.pos >= self.inner.len() { None } else { self.pos += 1; Some(unsafe { self.inner.get_unchecked(self.pos - 1) }) } } } /// Mutable iterator over [`CVec`]. /// /// You can get it from the [`CVec::iter_mut`] method. /// /// # 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 iter = cvec.iter_mut(); /// ``` pub struct CVecIterMut<'a, T: 'a> { inner: &'a mut CVec<T>, pos: usize, } impl<'a, T> Iterator for CVecIterMut<'a, T> { type Item = &'a mut T; fn next(&mut self) -> Option<Self::Item> { if self.pos >= self.inner.len() { None } else { self.pos += 1; Some(unsafe { &mut *self.inner.base.add(self.pos - 1) }) } } } /// 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()) }; /// ``` pub struct CVec<T> { base: *mut T, len: usize, dtor: Option<Box<dyn FnOnce(*mut T)>>, } impl<T> Drop for CVec<T> { fn drop(&mut self) { if let Some(f) = self.dtor.take() { f(self.base); } } } impl<T> 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()) }; /// ``` pub unsafe fn new(base: *mut T, len: usize) -> CVec<T> { assert!(!base.is_null()); CVec { base, len, dtor: None, } } /// 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!")) }; /// ``` pub unsafe fn new_with_dtor<F>(base: *mut T, len: usize, dtor: F) -> CVec<T> where F: FnOnce(*mut T) + 'static, { assert!(!base.is_null()); let dtor = Box::new(dtor); CVec { base, len, dtor: Some(dtor), } } /// 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)); /// ``` pub fn get(&self, ofs: usize) -> Option<&T> { if ofs < self.len { Some(unsafe { &*self.base.add(ofs) }) } else { None } } /// 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)); /// } /// ``` pub unsafe fn get_unchecked(&self, ofs: usize) -> &T { &*self.base.add(ofs) } /// 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); /// ``` pub fn get_mut(&mut self, ofs: usize) -> Option<&mut T> { if ofs < self.len { Some(unsafe { &mut *self.base.add(ofs) }) } else { None } } /// 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); /// ``` pub unsafe fn get_unchecked_mut<'a>(&'a mut self, ofs: usize) -> &mut T { &mut *self.base.add(ofs) } /// 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); /// ``` pub unsafe fn into_inner(mut self) -> *mut T { self.dtor = None; self.base } /// 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()); /// ``` pub fn len(&self) -> usize { self.len } /// 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()); /// ``` pub fn is_empty(&self) -> bool { self.len() == 0 } /// 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(); /// ``` pub fn as_cslice<'a>(&'a self) -> CSlice<'a, T> { CSlice { base: self.base, len: self.len, _phantom: PhantomData, } } /// 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(); /// ``` pub fn as_cslice_mut<'a>(&'a mut self) -> CSliceMut<'a, T> { CSliceMut { base: self.base, len: self.len, _phantom: PhantomData, } } /// 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); /// } /// ``` pub fn iter<'a>(&'a self) -> CVecIter<'a, T> { CVecIter { inner: self, pos: 0, } } /// 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); /// ``` pub fn iter_mut<'a>(&'a mut self) -> CVecIterMut<'a, T> { CVecIterMut { inner: self, pos: 0, } } } impl<T> AsRef<[T]> for CVec<T> { /// View the stored data as a slice. fn as_ref(&self) -> &[T] { unsafe { slice::from_raw_parts(self.base as *const T, self.len) } } } impl<T> AsMut<[T]> for CVec<T> { /// View the stored data as a slice. fn as_mut(&mut self) -> &mut [T] { unsafe { slice::from_raw_parts_mut(self.base, self.len) } } } impl<T> Index<usize> for CVec<T> { type Output = T; fn index(&self, index: usize) -> &T { assert!(index < self.len); unsafe { &*self.base.add(index) } } } impl<T> IndexMut<usize> for CVec<T> { fn index_mut(&mut self, index: usize) -> &mut T { assert!(index < self.len); unsafe { &mut *self.base.add(index) } } } impl<T: Clone> Into<Vec<T>> for CVec<T> { fn into(self: CVec<T>) -> Vec<T> { self.as_cslice().into() } }