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
use std::io::{Result, Error, ErrorKind};
use std::convert::TryFrom;

mod safe;
pub use safe::{Decoder, decode};

/// Read the next byte of the UTF-8 character out of the given byte iterator.
/// The byte is returned as a `u32` for later shifting.
/// Returns an `InvalidData` error if the byte is not part of a valid UTF-8 sequence.
/// Returns an `UnexpectedEof` error if the input iterator returns `None`.
fn next_byte<I: Iterator<Item=Result<u8>>>(iter: &mut I) -> Result<u32> {
    match iter.next() {
        Some(Ok(c)) => {
            if c & 0xC0 == 0x80 {
                Ok((c & 0x3F) as u32)
            } else {
                Err(Error::new(ErrorKind::InvalidData, "invalid UTF-8 sequence."))
            }
        },
        Some(Err(e)) => Err(e),
        None => Err(Error::new(ErrorKind::UnexpectedEof, "unexpected end of UTF-8 sequence."))
    }
}

/// Read the next Unicode codepoint given its first byte.
/// The first input byte is given as a `u32` for later shifting.
/// Returns an `InvalidData` error the input iterator does not output a valid UTF-8 sequence.
/// Returns an `UnexpectedEof` error if the input iterator returns `None` before the end of the
/// UTF-8 character.
fn raw_decode_from<I: Iterator<Item=Result<u8>>>(a: u32, iter: &mut I) -> Result<u32> {
    if a & 0x80 == 0x00 {
        Ok(a)
    } else if a & 0xE0 == 0xC0 {
        let b = next_byte(iter)?;
        Ok((a & 0x1F) << 6 | b)
    } else if a & 0xF0 == 0xE0 {
        let b = next_byte(iter)?;
        let c = next_byte(iter)?;
        Ok((a & 0x0F) << 12 | b << 6 | c)
    } else if a & 0xF8 == 0xF0 {
        let b = next_byte(iter)?;
        let c = next_byte(iter)?;
        let d = next_byte(iter)?;
        Ok((a & 0x07) << 18 | b << 12 | c << 6 | d)
    } else {
        Err(Error::new(ErrorKind::InvalidData, "invalid UTF-8 sequence."))
    }
}

/// Read the next Unicode character given its first byte.
/// Returns an `InvalidData` error the input iterator does not output a valid UTF-8 sequence.
/// Returns an `UnexpectedEof` error if the input iterator returns `None` before the end of the
/// UTF-8 character.
fn decode_from<I: Iterator<Item=Result<u8>>>(a: u32, iter: &mut I) -> Result<char> {
    match char::try_from(raw_decode_from(a, iter)?) {
        Ok(c) => Ok(c),
        Err(_) => Err(Error::new(ErrorKind::InvalidData, "invalid UTF-8 sequence."))
    }
}

/// Read the next Unicode character out of the given [`Result<u8>`](Iterator) iterator.
///
/// Returns `None` is the input iterator directly outputs `None`.
/// Returns an [`InvalidData`](std::io::ErrorKind::InvalidData) error the input iterator does not
/// output a valid UTF-8 sequence.
/// Returns an [`UnexpectedEof`](std::io::ErrorKind::UnexpectedEof) error if the input iterator
/// returns `None` before the end of an UTF-8 character.
pub fn decode_unsafe<I: Iterator<Item=Result<u8>>>(iter: &mut I) -> Option<Result<char>> {
	match iter.next() {
		Some(Ok(a)) => Some(decode_from(a as u32, iter)),
		Some(Err(e)) => Some(Err(e)),
		None => None
	}
}

/// UTF-8 decoder iterator for unsafe input.
///
/// Transform the given [`io::Result<u8>`](std::io::Result) iterator into a [`io::Result<char>`](std::io::Result) iterator.
/// This iterator can be useful to decode from an [`io::Read`](std::io::Read) source, but if your input
/// iterator iterates directly over `u8`, then use the [`Decoder`](crate::Decoder) iterator instead.
///
/// ## Example
/// The `UnsafeDecoder` iterator can be used, for instance, to decode UTF-8 encoded files.
/// ```[rust]
/// let file = File::open("file.txt")?;
///
/// let decoder = UnsafeDecoder::new(file.bytes());
///
/// let mut string = String::new();
/// for c in decoder {
///     string.push(c?);
/// }
/// ```
///
/// ## Errors
/// A call to [`next`](Iterator::next) returns an [`InvalidData`](std::io::ErrorKind::InvalidData)
/// error if the input iterator does not output a valid UTF-8 sequence, or an
/// [`UnexpectedEof`](std::io::ErrorKind::UnexpectedEof) if the stream ends before the end of a
/// valid character.
pub struct UnsafeDecoder<R: Iterator<Item=Result<u8>>> {
	bytes: R
}

impl<R: Iterator<Item=Result<u8>>> UnsafeDecoder<R> {
    /// Creates a new `Decoder` iterator from the given [`Result<u8>`](std::io::Result) source
    /// iterator.
	pub fn new(source: R) -> UnsafeDecoder<R> {
		UnsafeDecoder {
			bytes: source
		}
	}
}

impl<R: Iterator<Item=Result<u8>>> Iterator for UnsafeDecoder<R> {
	type Item = Result<char>;

	fn next(&mut self) -> Option<Result<char>> {
		decode_unsafe(&mut self.bytes)
	}
}