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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
//! A stream of chars for building such as a lexer. Making the step of "iteration between characters" considerably easier.
//! And providing certain utilites for making the code simpler.
//! Respects both ASCII and Unicode.
//!
//! Example, lexing identifiers, numbers and some punctuation marks:
//!
//! ```rust
//! use uwl::AsciiStream;
//! use uwl::StrExt;
//!
//! #[derive(Debug, PartialEq)]
//! enum TokenKind {
//!     Ident,
//!     Number,
//!     Question,
//!     Exclamation,
//!     Comma,
//!     Point,
//!
//!     // An invalid token
//!     Illegal,
//! }
//!
//! #[derive(Debug, PartialEq)]
//! struct Token<'a> {
//!     kind: TokenKind,
//!     lit: &'a str,
//! }
//!
//! impl<'a> Token<'a> {
//!     fn new(kind: TokenKind, lit: &'a str) -> Self {
//!         Token {
//!             kind,
//!             lit,
//!         }
//!     }
//! }
//!
//! fn lex<'a>(stream: &mut AsciiStream<'a>) -> Option<Token<'a>> {
//!     if stream.at_end() {
//!         return None;
//!     }
//!
//!     Some(match stream.current()? {
//!         // Ignore whitespace.
//!         s if s.is_whitespace() => {
//!             stream.next()?;
//!             return lex(stream);
//!         },
//!         s if s.is_alphabetic() => Token::new(TokenKind::Ident, stream.take_while(|s| s.is_alphabetic())),
//!         s if s.is_numeric() => Token::new(TokenKind::Number, stream.take_while(|s| s.is_numeric())),
//!         "?" => Token::new(TokenKind::Question, stream.next()?),
//!         "!" => Token::new(TokenKind::Exclamation, stream.next()?),
//!         "," => Token::new(TokenKind::Comma, stream.next()?),
//!         "." => Token::new(TokenKind::Point, stream.next()?),
//!         _ => Token::new(TokenKind::Illegal, stream.next()?),
//!     })
//! }
//!
//! fn main() {
//!     let mut stream = AsciiStream::new("Hello, world! ...world? Hello?");
//!
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Ident, "Hello")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Comma, ",")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Ident, "world")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Exclamation, "!")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Point, ".")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Point, ".")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Point, ".")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Ident, "world")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Question, "?")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Ident, "Hello")));
//!     assert_eq!(lex(&mut stream), Some(Token::new(TokenKind::Question, "?")));
//!
//!     // Reached the end
//!     assert_eq!(lex(&mut stream), None);
//! }
//! ```

#![no_std]

#![doc(html_root_url = "https://docs.rs/uwl/*")]
#![deny(rust_2018_idioms)]
#![allow(clippy::should_implement_trait)]

use core::fmt;
use core::marker::PhantomData;

/// Brings over some `is_*` methods from `char` to `&str`,
/// and some methods for identifiers/symbols.
///
/// Look at [`char`]'s docs for more reference.
///
/// [`char`]: https://doc.rust-lang.org/stable/std/primitive.char.html
pub trait StrExt {
    /// Does the string consist of numbers? (0-9)
    fn is_numeric(&self) -> bool;
    /// Does the string consist of letters? (A-Z)
    fn is_alphabetic(&self) -> bool;
    /// Does the string consist of letters or numbers? (A-Z; 0-9)
    fn is_alphanumeric(&self) -> bool;
    /// Does the string consist of whitespace? (\n; \r; ' ')
    fn is_whitespace(&self) -> bool;
    /// Does the string consist of letters, numbers or underscores? (A-Z; 0-9; _)
    fn is_diglet(&self) -> bool;
    /// Does the string consist of letters, numbers or hyphens? (A-Z; 0-9; -)
    fn is_kebab(&self) -> bool;
}

impl<T: AsRef<str>> StrExt for T {
    #[inline]
    fn is_numeric(&self) -> bool {
        self.as_ref().chars().all(|c| c.is_numeric())
    }

    #[inline]
    fn is_alphanumeric(&self) -> bool {
        self.as_ref().chars().all(|c| c.is_alphanumeric())
    }

    #[inline]
    fn is_alphabetic(&self) -> bool {
        self.as_ref().chars().all(|c| c.is_alphabetic())
    }

    #[inline]
    fn is_whitespace(&self) -> bool {
        self.as_ref().chars().all(|c| c.is_whitespace())
    }

    #[inline]
    fn is_diglet(&self) -> bool {
        self.as_ref()
            .chars()
            .all(|c| c == '_' || c.is_alphanumeric())
    }

    #[inline]
    fn is_kebab(&self) -> bool {
        self.as_ref()
            .chars()
            .all(|c| c == '-' || c.is_alphanumeric())
    }
}

// Copied from stackoverflow
// # https://stackoverflow.com/questions/43278245/find-next-char-boundary-index-in-string-after-char
fn find_end(s: &str, i: usize) -> Option<usize> {
    if i >= s.len() {
        return None;
    }

    let mut end = i + 1;
    while !s.is_char_boundary(end) {
        end += 1;
    }

    Some(end)
}

/// How the stream should be constitualizing "chars"
/// and how many bytes should it advance per "char".
///
/// There is [`Ascii`], which only advances the stream by one byte.
/// Then there's the [`Unicode`] advancer that not only handles ASCII, but
/// any utf-8 encoded character.
///
/// This trait is sealed. Outside the crate no type may implement this trait.
///
/// [`Ascii`]: struct.Ascii.html
/// [`Unicode`]: struct.Unicode.html
pub trait Advancer: sealed::Sealed {
    #[doc(hidden)]
    fn current(s: &str, offset: usize) -> Option<&str>;
}

#[derive(Debug, Default, Clone, Copy, PartialEq)]
pub struct Ascii;

impl Advancer for Ascii {
    #[inline]
    fn current(s: &str, offset: usize) -> Option<&str> {
        if offset < s.len() {
            Some(&s[offset..offset + 1])
        } else {
            None
        }
    }
}

#[derive(Debug, Default, Clone, Copy, PartialEq)]
pub struct Unicode;

impl Advancer for Unicode {
    #[inline]
    fn current(s: &str, offset: usize) -> Option<&str> {
        let start = offset;
        let end = find_end(s, offset)?;

        Some(&s[start..end])
    }
}

mod sealed {
    pub trait Sealed {}

    impl Sealed for super::Ascii {}
    impl Sealed for super::Unicode {}
}

/// A stream of "chars". Handles ASCII and/or Unicode depending on the [`Advancer`]
///
/// # Note
/// This stream's idea of a "char" is a string slice (`&str`).
/// In some of the methods, this slice may only be wide as any ASCII (and/or Unicode) character can be.
/// Others, such as [`take_while`], may return more than one "char".
///
/// [`Advancer`]: trait.Advancer.html
/// [`take_while`]: #method.take_while
pub struct Stream<'a, T: Advancer> {
    offset: usize,
    src: &'a str,
    _marker: PhantomData<T>,
}

impl<T: Advancer> fmt::Debug for Stream<'_, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Stream")
            .field("offset", &self.offset)
            .field("src", &self.src)
            .finish()
    }
}

impl<T: Advancer> Default for Stream<'_, T> {
    #[inline]
    fn default() -> Self {
        Stream {
            offset: 0,
            src: "",
            _marker: PhantomData,
        }
    }
}

impl<T: Advancer> Clone for Stream<'_, T> {
    #[inline]
    fn clone(&self) -> Self {
        Stream {
            offset: self.offset,
            src: self.src,
            _marker: PhantomData,
        }
    }
}

/// A stream of chars. Handles both ASCII and Unicode.
pub type UnicodeStream<'a> = Stream<'a, Unicode>;

/// A stream of chars. Handles only ASCII.
pub type AsciiStream<'a> = Stream<'a, Ascii>;

impl<'a, T: Advancer> Stream<'a, T> {
    /// Create a new stream from a source.
    #[inline]
    pub fn new(src: &'a str) -> Self {
        Stream {
            src,
            offset: 0,
            _marker: PhantomData,
        }
    }

    /// Fetch the current char.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let stream = AsciiStream::new("hello");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    /// ```
    #[inline]
    pub fn current(&self) -> Option<&'a str> {
        T::current(self.src, self.offset)
    }

    /// Advance to the next char
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    ///
    /// stream.next();
    /// assert_eq!(stream.current(), Some("e"));
    /// ```
    #[inline]
    pub fn next(&mut self) -> Option<&'a str> {
        let s = self.current()?;
        self.offset += s.len();

        Some(s)
    }

    /// Advance by x chars.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello world");
    ///
    /// assert_eq!(stream.advance(5), Some("hello"));
    /// stream.next();
    /// assert_eq!(stream.advance(5), Some("world"));
    /// assert!(stream.at_end());
    /// ```
    #[inline]
    pub fn advance(&mut self, much: usize) -> Option<&'a str> {
        if self.at_end() {
            None
        } else {
            let s = self.peek_for(much);
            self.offset += s.len();

            Some(s)
        }
    }

    /// Advance if the leading string matches to the expected input.
    /// Returns `true` on succession, `false` on failure.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello world");
    ///
    /// assert!(stream.eat("hello"));
    /// assert!(!stream.eat("not a space"));
    /// assert!(stream.eat(" "));
    /// assert_eq!(stream.rest(), "world");
    /// ```
    #[inline]
    pub fn eat(&mut self, m: &str) -> bool {
        if self.peek_for(m.chars().count()) == m {
            self.offset += m.len();

            true
        } else {
            false
        }
    }

    /// Lookahead by x chars. Returns the char it landed on.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    /// assert_eq!(stream.peek(1), Some("e"));
    /// assert_eq!(stream.current(), Some("h"));
    /// assert_eq!(stream.peek(2), Some("l"));
    /// assert_eq!(stream.current(), Some("h"));
    /// ```
    #[inline]
    pub fn peek(&self, ahead: usize) -> Option<&'a str> {
        self.peek_internal(ahead).1
    }

    /// Lookahead by x chars. Returns a substring up to the end it landed on.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello world");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    /// assert_eq!(stream.peek_for(5), "hello");
    ///
    /// for _ in 0..5 {
    ///     stream.next();
    /// }
    ///
    /// assert_eq!(stream.next(), Some(" "));
    /// assert_eq!(stream.peek_for(5), "world");
    /// assert_eq!(stream.next(), Some("w"));
    /// assert_eq!(stream.next(), Some("o"));
    /// assert_eq!(stream.next(), Some("r"));
    /// assert_eq!(stream.next(), Some("l"));
    /// assert_eq!(stream.next(), Some("d"));
    /// ```
    #[inline]
    pub fn peek_for(&self, ahead: usize) -> &'a str {
        self.peek_internal(ahead).0
    }

    /// Lookahead for as long as `f` returns true. Returns a substring up to the end it landed on.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::{AsciiStream, StrExt};
    ///
    /// let mut stream = AsciiStream::new("hello _wo_r_l_4d");
    ///
    /// assert_eq!(stream.peek_while(|s| s.is_alphabetic()), "hello");
    /// assert_eq!(stream.rest(), "hello _wo_r_l_4d");
    /// stream.take_while(|s| s.is_alphabetic());
    /// stream.next();
    /// assert_eq!(stream.peek_while(|s| s.is_diglet()), "_wo_r_l_4d");
    /// assert_eq!(stream.rest(), "_wo_r_l_4d");
    /// ```
    #[inline]
    pub fn peek_while(&self, f: impl Fn(&str) -> bool) -> &'a str {
        self.clone().take_while(f)
    }

    /// Lookahead for as long as `f` does not return true. Returns a substring up to the end it landed on.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello!");
    ///
    /// assert_eq!(stream.peek_until(|s| s == "!"), "hello");
    /// assert_eq!(stream.rest(), "hello!");
    /// ```
    #[inline]
    pub fn peek_until(&self, f: impl Fn(&str) -> bool) -> &'a str {
        self.peek_while(|s| !f(s))
    }

    fn peek_internal(&self, ahead: usize) -> (&'a str, Option<&'a str>) {
        if self.at_end() {
            return ("", None);
        }

        let mut copy = self.clone();

        let pos = copy.offset;

        for _ in 0..ahead {
            copy.next();
        }

        let s = &self.src[pos..copy.offset];
        let c = copy.current();

        (s, c)
    }

    /// Consume while true.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// // Import a few utility methods (for `is_alphabetic`)
    /// use uwl::StrExt;
    ///
    /// let mut stream = AsciiStream::new("hello");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    /// assert_eq!(stream.take_while(|s| s.is_alphabetic()), "hello");
    /// assert_eq!(stream.current(), None);
    /// ```
    pub fn take_while(&mut self, f: impl Fn(&str) -> bool) -> &'a str {
        if self.at_end() {
            return "";
        }

        let start = self.offset;

        while let Some(s) = self.current() {
            if !f(s) {
                break;
            }

            self.offset += s.len();
        }

        &self.src[start..self.offset]
    }

    /// Consume until true.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("hello!");
    ///
    /// assert_eq!(stream.current(), Some("h"));
    /// assert_eq!(stream.take_until(|s| s == "!"), "hello");
    /// assert_eq!(stream.current(), Some("!"));
    /// ```
    #[inline]
    pub fn take_until(&mut self, f: impl Fn(&str) -> bool) -> &'a str {
        self.take_while(|s| !f(s))
    }

    /// Slice a portion from the stream by using rules defined by the formatting string
    ///
    /// - `{}` => the portion to return
    /// - `(x)` => optional text *x* that may be present, ignored
    /// - letters/numbers => text to expect
    ///
    /// To espace `{` or `(`, use them twice. For example, `((`/`{{`.
    /// This is not necessary for `}` or `)`.
    ///
    /// Whitespace between `{` and `}` is skipped.
    ///
    /// If parsing does not succeed, this won't advance.
    /// On `Err`, the expected string, or "parse failed", are returned.
    ///
    /// # Examples
    ///
    /// Get anything between html `h1` tags
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("<h1>hello world!</h1>");
    ///
    /// assert_eq!(stream.parse("<h1>{}</h1>"), Ok("hello world!"));
    /// ```
    ///
    /// Parse html tags
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("<h2></h2>");
    ///
    /// // the opening tag - <h2>
    /// assert_eq!(stream.parse("<(/){}>"), Ok("h2"));
    /// // the closing tag - </h2>
    /// assert_eq!(stream.parse("<(/){}>"), Ok("h2"));
    /// ```
    pub fn parse<'b>(&mut self, fmt: &'b str) -> Result<&'a str, &'b str> {
        enum Format<'a> {
            Expect(&'a str),
            Optional(&'a str),
            Parse(Option<&'a str>),
        }

        fn parse<'a, T: Advancer>(stream: &mut Stream<'a, T>) -> Option<Format<'a>> {
            if stream.at_end() {
                return None;
            }

            if stream.eat("((") {
                return Some(Format::Expect("("));
            }

            if stream.eat("{{") {
                return Some(Format::Expect("{"));
            }

            if stream.eat("(") {
                let e = stream.take_until(|s| s == ")");
                stream.eat(")");
                return Some(Format::Optional(e));
            }

            if stream.eat("{") {
                stream.take_while(|s| s.is_whitespace());
                stream.eat("}");

                return Some(Format::Parse(stream.current()));
            }

            Some(Format::Expect(stream.take_until(|s| s == "(" || s == "{")))
        }

        let pos = self.offset();
        let mut s = Stream::<T>::new(fmt);

        let mut res = None;
        while let Some(fmt) = parse(&mut s) {
            match fmt {
                Format::Expect(e) => {
                    if !self.eat(e) {
                        return Err(e);
                    }
                }
                Format::Optional(e) => {
                    self.eat(e);
                }
                Format::Parse(e) => {
                    res = match e {
                        Some(e) => Some(self.take_until(|s| s == e)),
                        None => Some(self.rest()),
                    };
                }
            }
        }

        match res {
            Some(r) => Ok(r),
            None => {
                // Refresh the offset since we had failed.
                unsafe { self.set_unchecked(pos) };

                Err("parse failed")
            }
        }
    }

    /// Returns the remainder (after the offset).
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("foo bar");
    ///
    /// assert_eq!(stream.take_until(|s| s == " "), "foo");
    /// assert_eq!(stream.next(), Some(" "));
    /// assert_eq!(stream.rest(), "bar");
    #[inline]
    pub fn rest(&self) -> &'a str {
        &self.src[self.offset()..]
    }

    /// Determines the end of the input.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let mut stream = AsciiStream::new("a");
    ///
    /// assert!(!stream.at_end());
    /// stream.next();
    /// assert!(stream.at_end());
    /// assert_eq!(stream.current(), None);
    /// ```
    #[inline]
    pub fn at_end(&self) -> bool {
        self.offset >= self.len()
    }

    /// The "offset"; the start of the current char.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::UnicodeStream;
    ///
    /// let mut stream = UnicodeStream::new("a 🍆");
    ///
    /// assert_eq!(stream.offset(), 0);
    /// stream.next();
    /// assert_eq!(stream.offset(), 1);
    /// stream.next();
    /// assert_eq!(stream.offset(), 2);
    /// stream.next();
    /// assert_eq!(stream.offset(), 6);
    /// ```
    #[inline]
    pub fn offset(&self) -> usize {
        self.offset
    }

    /// Returns the source the stream is operating on.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let stream = AsciiStream::new("Once upon a time... life");
    ///
    /// assert_eq!(stream.source(), "Once upon a time... life");
    /// ```
    #[inline]
    pub fn source(&self) -> &'a str {
        self.src
    }

    /// The provided source's length. Returns the amount of bytes.
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::UnicodeStream;
    ///
    /// let mut stream = UnicodeStream::new("abc🍆");
    /// assert_eq!(stream.len(), 7);
    /// stream.next();
    /// // Regardless of any modification method present on the stream,
    /// // `len` always returns a constant.
    /// assert_eq!(stream.len(), 7);
    /// ```
    #[inline]
    pub fn len(&self) -> usize {
        self.src.len()
    }

    /// Is the provided source empty?
    ///
    /// # Example
    ///
    /// ```rust
    /// use uwl::AsciiStream;
    ///
    /// let stream = AsciiStream::new("");
    ///
    /// assert!(stream.is_empty());
    /// assert_eq!(stream.source(), "");
    /// ```
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Set the offset.
    ///
    /// Panics if the offset is in the middle of a unicode character.
    pub fn set(&mut self, pos: usize) {
        if !self.src.is_char_boundary(pos) {
            panic!("offset in the middle of a unicode character");
        }

        self.offset = pos;
    }

    /// Set the offset without any checks.
    #[inline]
    pub unsafe fn set_unchecked(&mut self, pos: usize) {
        self.offset = pos;
    }

    /// Increment the offset by bytes.
    ///
    /// Panics if the offset appears to be in the middle of a unicode character.
    pub fn increment(&mut self, bytes: usize) {
        let incr = self.offset + bytes;
        if !self.src.is_char_boundary(incr) {
            panic!("offset in the middle of a unicode character");
        }

        self.offset = incr;
    }

    /// Increment the offset by bytes without any checks.
    #[inline]
    pub unsafe fn increment_unchecked(&mut self, bytes: usize) {
        self.offset += bytes;
    }
}

impl<'a> AsciiStream<'a> {
    /// Convert this ascii stream into a unicode stream.
    pub fn into_unicode(self) -> UnicodeStream<'a> {
        UnicodeStream {
            offset: self.offset,
            src: self.src,
            _marker: PhantomData,
        }
    }
}

impl<'a> UnicodeStream<'a> {
    /// Convert this unicode stream into an ascii stream.
    pub fn into_ascii(self) -> AsciiStream<'a> {
        AsciiStream {
            offset: self.offset,
            src: self.src,
            _marker: PhantomData,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    extern crate std;
    use self::std::vec::Vec;

    #[test]
    fn all_chars() {
        const STRING: &str = "hello a b c ! ?👀👁!!!";
        let mut s = UnicodeStream::new(STRING);

        let mut v = Vec::with_capacity(STRING.len());

        while let Some(s) = s.next() {
            v.push(s);
        }

        assert_eq!(&v[0], &"h");
        assert_eq!(&v[1], &"e");
        assert_eq!(&v[2], &"l");
        assert_eq!(&v[3], &"l");
        assert_eq!(&v[4], &"o");
        assert_eq!(&v[5], &" ");
        assert_eq!(&v[6], &"a");
        assert_eq!(&v[7], &" ");
        assert_eq!(&v[8], &"b");
        assert_eq!(&v[9], &" ");
        assert_eq!(&v[10], &"c");
        assert_eq!(&v[11], &" ");
        assert_eq!(&v[12], &"!");
        assert_eq!(&v[13], &" ");
        assert_eq!(&v[14], &"?");
        assert_eq!(&v[15], &"👀");
        assert_eq!(&v[16], &"👁");
        assert_eq!(&v[17], &"!");
        assert_eq!(&v[18], &"!");
        assert_eq!(&v[19], &"!");
        assert_eq!(v.len(), 20);

        // There are no other characters beyond index `19`
        assert_eq!(v.get(20), None);
    }

    #[test]
    fn peek() {
        const STRING: &str = "// a comment!";

        let mut s = AsciiStream::new(STRING);

        assert_eq!(s.current(), Some("/"));
        // Forsee into the future. By one char.
        assert_eq!(s.peek(1), Some("/"));

        // Although `peek` takes by `&mut self`, it shouldn't alter the order of our input we'll want to parse.
        assert_eq!(s.next(), Some("/"));
        assert_eq!(s.next(), Some("/"));

        assert_eq!(&s.src[s.offset()..], " a comment!");
    }
}