src/libcore/iter_private.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11
  12 /// An iterator whose items are random accessible efficiently
  13 ///
  14 /// # Safety
  15 ///
  16 /// The iterator's .len() and size_hint() must be exact.
  17 /// `.len()` must be cheap to call.
  18 ///
  19 /// .get_unchecked() must return distinct mutable references for distinct
  20 /// indices (if applicable), and must return a valid reference if index is in
  21 /// 0..self.len().
  22 #[doc(hidden)]
  23 pub unsafe trait TrustedRandomAccess : ExactSizeIterator {
  24     unsafe fn get_unchecked(&mut self, i: usize) -> Self::Item;
  25     /// Returns `true` if getting an iterator element may have
  26     /// side effects. Remember to take inner iterators into account.
  27     fn may_have_side_effect() -> bool;
  28 }