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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
//! Joinery iterator and related types and traits use core::fmt::{self, Debug, Display, Formatter}; use core::iter::{FusedIterator, Peekable}; #[cfg(feature = "nightly")] use core::iter::TrustedLen; use crate::join::{Join, Joinable}; use crate::separators::NoSeparator; /// Specialized helper struct to allow adapting any [`Iterator`] into a [`Join`]. /// /// [`Join`] requires the underlying object to be `&T: IntoIterator`, so that /// it can be iterated over when formatting via [`Display`]. This works fine for /// collection types like [`Vec`](https://doc.rust-lang.org/std/vec/struct.Vec.html), /// but it doesn't work for arbitrary iterators. However, because many iterators /// are cheaply clonable (because they often just contain a reference to the /// underlying sequence), we can use this adapter to create an `&T: IntoIterator` /// type which can be displayed by `Join`. #[derive(Debug, Clone, Eq, PartialEq)] #[repr(transparent)] pub struct CloneIterator<I>(I); impl<I: Iterator> IntoIterator for CloneIterator<I> { type IntoIter = I; type Item = I::Item; /// Convert the adapter back into the underlying iterator. fn into_iter(self) -> Self::IntoIter { self.0 } } impl<'a, I: Iterator + Clone> IntoIterator for &'a CloneIterator<I> { type IntoIter = I; type Item = I::Item; /// Create a referential iterator by cloning the underlying iterator. Note /// that this will have the same `Item` type as the underlying iterator, /// rather than references to those items. fn into_iter(self) -> Self::IntoIter { self.0.clone() } } /// A trait for converting [`Iterator`]s into [`Join`] instances or [`JoinIter`] /// iterators. /// /// This trait serves the same purpose as [`Joinable`], but is implemented for `Iterator` /// types. The main difference between [`JoinableIterator`] and [`Joinable`] is that, /// because iterators generally don't implement `&T: IntoIterator`, we need a different /// mechanism to allow for immutably iterating (which is required for [`Join`]'s implementation /// of [`Display`]). pub trait JoinableIterator: Iterator + Sized { /// Convert a cloneable iterator into a [`Join`] instance. Whenever the [`Join`] /// needs to immutabley iterate over the underlying iterator (for instance, when /// formatting it with [`Display`]), the underlying iterator is cloned. For most /// iterator types this is a cheap operation, because the iterator contains just /// a reference to the underlying collection. /// /// # Examples /// /// ``` /// use joinery::JoinableIterator; /// /// let result = (0..4).map(|x| x * 2).join_with(", ").to_string(); /// /// assert_eq!(result, "0, 2, 4, 6"); /// ``` fn join_with<S>(self, sep: S) -> Join<CloneIterator<Self>, S> where Self: Clone, { CloneIterator(self).join_with(sep) } /// Convert a [cloneable][Clone] iterator into a [`Join`] instance with no separator. /// When formatted with [`Display`], the elements of the iterator will be directly /// concatenated. /// # Examples /// /// ``` /// use joinery::JoinableIterator; /// /// let result = (0..4).map(|x| x * 2).join_concat().to_string(); /// /// assert_eq!(result, "0246"); /// ``` fn join_concat(self) -> Join<CloneIterator<Self>, NoSeparator> where Self: Clone, { self.join_with(NoSeparator) } /// Create an iterator which interspeses the elements of this iterator with /// a separator. See [`JoinIter`] for more details. /// /// # Examples /// /// ``` /// use joinery::{JoinableIterator, JoinItem}; /// /// let mut iter = (0..3).map(|x| x * 2).iter_join_with(", "); /// /// assert_eq!(iter.next(), Some(JoinItem::Element(0))); /// assert_eq!(iter.next(), Some(JoinItem::Separator(", "))); /// assert_eq!(iter.next(), Some(JoinItem::Element(2))); /// assert_eq!(iter.next(), Some(JoinItem::Separator(", "))); /// assert_eq!(iter.next(), Some(JoinItem::Element(4))); /// assert_eq!(iter.next(), None); /// ``` fn iter_join_with<S>(self, sep: S) -> JoinIter<Self, S> { JoinIter::new(self, sep) } } impl<T: Iterator> JoinableIterator for T {} /// Enum representing the elements of a [`JoinIter`]. #[derive(Debug, Clone, PartialEq, Eq, Hash)] pub enum JoinItem<T, S> { /// An element from the underlying iterator Element(T), /// A separator between two elements Separator(S), } impl<T, S> JoinItem<T, S> { /// Convert a [`JoinItem`] into a common type `R`, in the case where both /// `T` and `S` can be converted to `R`. Unfortunately, due to potentially /// conflicting implementations, we can't implement [`Into<R>`][Into] for /// [`JoinItem`]. pub fn into<R>(self) -> R where T: Into<R>, S: Into<R>, { match self { JoinItem::Element(el) => el.into(), JoinItem::Separator(sep) => sep.into(), } } } impl<R, T: AsRef<R>, S: AsRef<R>> AsRef<R> for JoinItem<T, S> { /// Get a reference to a common type `R` from a [`JoinItem`], in the case where /// both `T` and `S` implement [`AsRef<R>`][AsRef] fn as_ref(&self) -> &R { match self { JoinItem::Element(el) => el.as_ref(), JoinItem::Separator(sep) => sep.as_ref(), } } } impl<R, T: AsMut<R>, S: AsMut<R>> AsMut<R> for JoinItem<T, S> { /// Get a mutable reference to a common type `R` from a [`JoinItem`], in the /// case where both `T` and `S` implement [`AsMut<R>`][AsMut] fn as_mut(&mut self) -> &mut R { match self { JoinItem::Element(el) => el.as_mut(), JoinItem::Separator(sep) => sep.as_mut(), } } } impl<T: Display, S: Display> Display for JoinItem<T, S> { fn fmt(&self, f: &mut Formatter) -> fmt::Result { match self { JoinItem::Element(el) => el.fmt(f), JoinItem::Separator(sep) => sep.fmt(f), } } } /// An iterator for a [`Join`]. /// /// Emits the elements of the [`Join`]'s underlying iterator, interspersed with /// its separator. Note that it uses [`clone`][Clone::clone] to generate copies /// of the separator while iterating, but also keep in mind that in most cases /// the [`JoinItem`] instance will have a trivially cloneable separator, such /// as [`&`](https://doc.rust-lang.org/std/primitive.reference.html)[`str`][str] /// or [`char`]. /// /// # Examples /// /// Via [`IntoIterator`]: /// /// ``` /// use joinery::{Joinable, JoinItem}; /// /// let join = vec![1, 2, 3].join_with(" "); /// let mut join_iter = join.into_iter(); /// /// assert_eq!(join_iter.next(), Some(JoinItem::Element(1))); /// assert_eq!(join_iter.next(), Some(JoinItem::Separator(" "))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element(2))); /// assert_eq!(join_iter.next(), Some(JoinItem::Separator(" "))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element(3))); /// assert_eq!(join_iter.next(), None); /// ``` /// /// Via [`iter_join_with`][JoinableIterator::iter_join_with]: /// /// ``` /// use joinery::{JoinableIterator, JoinItem}; /// /// let mut iter = (0..6) /// .filter(|x| x % 2 == 0) /// .map(|x| x * 2) /// .iter_join_with(", "); /// /// assert_eq!(iter.next(), Some(JoinItem::Element(0))); /// assert_eq!(iter.next(), Some(JoinItem::Separator(", "))); /// assert_eq!(iter.next(), Some(JoinItem::Element(4))); /// assert_eq!(iter.next(), Some(JoinItem::Separator(", "))); /// assert_eq!(iter.next(), Some(JoinItem::Element(8))); /// assert_eq!(iter.next(), None); /// ``` #[must_use] pub struct JoinIter<Iter: Iterator, Sep> { iter: Peekable<Iter>, sep: Sep, next_sep: bool, } impl<I: Iterator, S> JoinIter<I, S> { /// Construct a new [`JoinIter`] using an iterator and a separator fn new(iter: I, sep: S) -> Self { JoinIter { iter: iter.peekable(), sep, next_sep: false, } } } impl<I: Iterator, S> JoinIter<I, S> { /// Check if the next iteration of this iterator will (try to) return a /// separator. Note that this does not check if the underlying iterator is /// empty, so the next `next` call could still return `None`. /// /// # Examples /// /// ``` /// use joinery::{JoinableIterator, JoinItem}; /// /// let mut join_iter = (0..3).join_with(", ").into_iter(); /// /// assert_eq!(join_iter.is_sep_next(), false); /// join_iter.next(); /// assert_eq!(join_iter.is_sep_next(), true); /// join_iter.next(); /// assert_eq!(join_iter.is_sep_next(), false); /// ``` #[inline] pub fn is_sep_next(&self) -> bool { self.next_sep } /// Get a reference to the separator. #[inline] pub fn sep(&self) -> &S { &self.sep } /// Peek at what the next item in the iterator will be without consuming /// it. Note that this interface is similar, but not identical, to /// [`Peekable::peek`]. /// /// # Examples /// /// ``` /// use joinery::{JoinableIterator, JoinItem}; /// /// let mut join_iter = (0..3).join_with(", ").into_iter(); /// /// assert_eq!(join_iter.peek(), Some(JoinItem::Element(&0))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element(0))); /// assert_eq!(join_iter.peek(), Some(JoinItem::Separator(&", "))); /// assert_eq!(join_iter.next(), Some(JoinItem::Separator(", "))); /// assert_eq!(join_iter.peek(), Some(JoinItem::Element(&1))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element(1))); /// ``` pub fn peek(&mut self) -> Option<JoinItem<&I::Item, &S>> { let sep = &self.sep; let next_sep = self.next_sep; self.iter.peek().map(move |element| { if next_sep { JoinItem::Separator(sep) } else { JoinItem::Element(element) } }) } /// Peek at what the next non-separator item in the iterator will be /// without consuming it. /// /// # Examples /// /// ``` /// use joinery::{Joinable, JoinItem}; /// /// let mut join_iter = vec!["This", "is", "a", "sentence"].join_with(' ').into_iter(); /// /// assert_eq!(join_iter.peek_element(), Some(&"This")); /// assert_eq!(join_iter.peek(), Some(JoinItem::Element(&"This"))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element("This"))); /// /// assert_eq!(join_iter.peek_element(), Some(&"is")); /// assert_eq!(join_iter.peek(), Some(JoinItem::Separator(&' '))); /// assert_eq!(join_iter.next(), Some(JoinItem::Separator(' '))); /// /// assert_eq!(join_iter.peek_element(), Some(&"is")); /// assert_eq!(join_iter.peek(), Some(JoinItem::Element(&"is"))); /// assert_eq!(join_iter.next(), Some(JoinItem::Element("is"))); /// ``` pub fn peek_element(&mut self) -> Option<&I::Item> { self.iter.peek() } } impl<I: Debug + Iterator, S: Debug> Debug for JoinIter<I, S> where I::Item: Debug, { fn fmt(&self, f: &mut Formatter) -> fmt::Result { f.debug_struct("JoinIter") .field("iter", &self.iter) .field("sep", &self.sep) .field("next_sep", &self.next_sep) .finish() } } impl<I: Clone + Iterator, S: Clone> Clone for JoinIter<I, S> where I::Item: Clone, // Needed because we use a peekable iterator { fn clone(&self) -> Self { JoinIter { iter: self.iter.clone(), sep: self.sep.clone(), next_sep: self.next_sep, } } fn clone_from(&mut self, source: &Self) { self.iter.clone_from(&source.iter); self.sep.clone_from(&source.sep); self.next_sep = source.next_sep; } } /// Get the size of a [`JoinIter`], given the size of the underlying iterator. If /// next_sep is true, the next element in the [`JoinIter`] will be the separator. /// Return None in the event of an overflow. This logic is provided as a separate /// function in the hopes that it will aid compiler optimization, and also with /// the intention that in the future it will be a `const fn`. #[inline] fn join_size(iter_size: usize, next_sep: bool) -> Option<usize> { if iter_size == 0 { Some(0) } else if next_sep { iter_size.checked_mul(2) } else { // TODO: this might be faster with wrapping operations and explicit checks // Interestingly, If checked_mul didn't overflow, then the +1 is also // guarenteed to not overflow. (iter_size - 1).checked_mul(2).map(|val| val + 1) } } impl<I: Iterator, S: Clone> Iterator for JoinIter<I, S> { type Item = JoinItem<I::Item, S>; /// Advance to the next item in the Join. This will either be the next /// element in the underlying iterator, or a clone of the separator. // We tag it inline in the hopes that the compiler can optimize loops into // (mostly) branchless versions, similar to `(Join as Display)::fmt` #[inline] fn next(&mut self) -> Option<Self::Item> { let sep = &self.sep; let next_sep = &mut self.next_sep; if *next_sep { self.iter.peek().map(|_| { *next_sep = false; JoinItem::Separator(sep.clone()) }) } else { self.iter.next().map(|element| { *next_sep = true; JoinItem::Element(element) }) } } fn size_hint(&self) -> (usize, Option<usize>) { let (min, max) = self.iter.size_hint(); let min = join_size(min, self.next_sep).unwrap_or(core::usize::MAX); let max = max.and_then(|max| join_size(max, self.next_sep)); (min, max) } fn fold<B, F>(self, init: B, mut func: F) -> B where F: FnMut(B, Self::Item) -> B, { let mut iter = self.iter.map(JoinItem::Element); let sep = self.sep; let accum = if self.next_sep { init } else { match iter.next() { None => return init, Some(element) => func(init, element), } }; iter.fold(accum, move |accum, element| { let accum = func(accum, JoinItem::Separator(sep.clone())); func(accum, element) }) } // TODO: Add try_fold implementation based on self.iter.try_fold. // Unfortunately, this will be difficult (and probably impossible), because // when the reducer function is called, it has to process both the element // and the separator, either of which could result in an early return. } impl<I: FusedIterator, S: Clone> FusedIterator for JoinIter<I, S> {} #[cfg(feature = "nightly")] unsafe impl<I: TrustedLen, S: Clone> TrustedLen for JoinIter<I, S> {} #[cfg(test)] mod tests { use super::JoinItem::*; use super::JoinableIterator; #[test] fn empty_iter() { let mut join_iter = (0..0).iter_join_with(", "); assert_eq!(join_iter.next(), None); assert_eq!(join_iter.next(), None); } #[test] fn single() { let mut join_iter = (0..1).iter_join_with(", "); assert_eq!(join_iter.next(), Some(Element(0))); assert_eq!(join_iter.next(), None); assert_eq!(join_iter.next(), None); } #[test] fn few() { let mut join_iter = (0..3).iter_join_with(", "); assert_eq!(join_iter.next(), Some(Element(0))); assert_eq!(join_iter.next(), Some(Separator(", "))); assert_eq!(join_iter.next(), Some(Element(1))); assert_eq!(join_iter.next(), Some(Separator(", "))); assert_eq!(join_iter.next(), Some(Element(2))); assert_eq!(join_iter.next(), None); assert_eq!(join_iter.next(), None); } #[test] fn regular_size_hint() { let mut join_iter = (0..10).iter_join_with(", "); for size in (0..=19).rev() { assert_eq!(join_iter.size_hint(), (size, Some(size))); join_iter.next(); } assert_eq!(join_iter.size_hint(), (0, Some(0))); join_iter.next(); assert_eq!(join_iter.size_hint(), (0, Some(0))); } #[test] fn large_size_hint() { let join_iter = (0..usize::max_value() - 10).iter_join_with(", "); assert_eq!(join_iter.size_hint(), (usize::max_value(), None)); } #[test] fn threshold_size_hint() { use core::usize::MAX as usize_max; let usize_threshold = (usize_max / 2) + 1; let mut join_iter = (0..usize_threshold + 1).iter_join_with(", "); assert_eq!(join_iter.size_hint(), (usize_max, None)); join_iter.next(); assert_eq!(join_iter.size_hint(), (usize_max, None)); join_iter.next(); assert_eq!(join_iter.size_hint(), (usize_max, Some(usize_max))); join_iter.next(); assert_eq!(join_iter.size_hint(), (usize_max - 1, Some(usize_max - 1))); } #[test] fn partial_iteration() { use std::vec::Vec; let mut join_iter = (0..3).iter_join_with(' '); join_iter.next(); let rest: Vec<_> = join_iter.collect(); assert_eq!( rest, [Separator(' '), Element(1), Separator(' '), Element(2),] ); } #[test] fn fold() { let content = [1, 2, 3]; let join_iter = content.iter().iter_join_with(4); let sum = join_iter.fold(0, |accum, next| match next { Element(el) => accum + el, Separator(sep) => accum + sep, }); assert_eq!(sum, 14); } #[test] fn partial_fold() { let content = [1, 2, 3, 4]; let mut join_iter = content.iter().iter_join_with(1); join_iter.next(); join_iter.next(); join_iter.next(); let sum = join_iter.fold(0, |accum, next| match next { Element(el) => accum + el, Separator(sep) => accum + sep, }); assert_eq!(sum, 9); } #[test] fn try_fold() { let content = [1, 2, 0, 3]; let mut join_iter = content.iter().iter_join_with(1); let result = join_iter.try_fold(0, |accum, next| match next { Separator(sep) => Ok(accum + sep), Element(el) if *el == 0 => Err(accum), Element(el) => Ok(accum + el), }); assert_eq!(result, Err(5)); } // This test exists because implementing JoinIter::try_fold in terms of // JoinIter.iter::try_fold is non trivial, and the naive (incorrect) implementation // fails this test. #[test] fn partial_try_fold() { let content = [1, 2, 3]; let mut join_iter = content.iter().iter_join_with(1); let _ = join_iter.try_fold(1, |_, next| match next { Element(_) => Some(1), Separator(_) => None, }); // At this point, the remaining elements in the iterator SHOULD be E(2), S(1), E(3) assert_eq!(join_iter.count(), 3); } }