nt-string 0.1.1

Idiomatic Rust implementations for various Windows string types
Documentation 
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

// Copyright 2023 Colin Finck <colin@reactos.org>
// SPDX-License-Identifier: MIT OR Apache-2.0
//
//! Iterator implementations for [`NtUnicodeStr`].

use core::iter::{Copied, FusedIterator};
use core::slice::Iter;

use widestring::iter::{DecodeUtf16, DecodeUtf16Lossy};
use widestring::{decode_utf16, decode_utf16_lossy};

use super::NtUnicodeStr;
use crate::error::Result;

/// An iterator over the UTF-16 decoded [`char`]s of [`NtUnicodeStr`],
/// which returns an error for unparsed surrogates.
///
/// This struct is created by the [`NtUnicodeStr::chars`] method.
///
/// [`NtUnicodeStr::chars`]: crate::unicode_string::NtUnicodeStr::chars
#[derive(Clone, Debug)]
pub struct Chars<'a> {
    iter: DecodeUtf16<Copied<Iter<'a, u16>>>,
}

impl<'a> Chars<'a> {
    pub(crate) fn new(unicode_str: &'a NtUnicodeStr) -> Self {
        Self {
            iter: decode_utf16(unicode_str.u16_iter()),
        }
    }
}

impl<'a> Iterator for Chars<'a> {
    type Item = Result<char>;

    fn next(&mut self) -> Option<Self::Item> {
        let result = self.iter.next()?;
        Some(result.map_err(Into::into))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

impl<'a> FusedIterator for Chars<'a> {}

impl<'a> DoubleEndedIterator for Chars<'a> {
    fn next_back(&mut self) -> Option<Self::Item> {
        let result = self.iter.next_back()?;
        Some(result.map_err(Into::into))
    }
}

/// An iterator over the UTF-16 decoded [`char`]s of [`NtUnicodeStr`],
/// which automatically replaces unparsed surrogates by [`U+FFFD REPLACEMENT CHARACTER`] (�).
///
/// This struct is created by the [`NtUnicodeStr::chars_lossy`] method.
///
/// [`NtUnicodeStr::chars_lossy`]: crate::unicode_string::NtUnicodeStr::chars_lossy
/// [`U+FFFD REPLACEMENT CHARACTER`]: std::char::REPLACEMENT_CHARACTER
#[derive(Clone, Debug)]
pub struct CharsLossy<'a> {
    iter: DecodeUtf16Lossy<Copied<Iter<'a, u16>>>,
}

impl<'a> CharsLossy<'a> {
    pub(crate) fn new(unicode_str: &'a NtUnicodeStr) -> Self {
        Self {
            iter: decode_utf16_lossy(unicode_str.u16_iter()),
        }
    }
}

impl<'a> Iterator for CharsLossy<'a> {
    type Item = char;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next()
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

impl<'a> FusedIterator for CharsLossy<'a> {}

impl<'a> DoubleEndedIterator for CharsLossy<'a> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.iter.next_back()
    }
}