averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

[stdlib] Revise comments per proposed revisions to SE-0163

Browse Source
This commit is contained in:
Dave Abrahams
2017-05-09 18:36:30 -07:00
parent c64534a873
commit c616b180ce
2 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
stdlib/public/core/UnicodeParser.swift
View File

@@ -10,18 +10,31 @@
//
//===----------------------------------------------------------------------===//
extension _Unicode {
/// The result of attempting to parse a `T` from some input.
public enum ParseResult<T> {
/// A `T` was parsed successfully
case valid(T)
/// The input was entirely consumed.
case emptyInput
/// An encoding error was detected.
///
/// `length` is the number of underlying code units consumed by this
/// error (the length of the longest prefix of a valid encoding
/// sequence that could be recognized).
case error(length: Int)
}
}
/// Types that separate streams of code units into encoded unicode scalar values
/// Types that separate streams of code units into encoded Unicode
/// scalar values.
public protocol UnicodeParser {
/// The encoding with which this parser is associated
associatedtype Encoding : _UnicodeEncoding
/// Constructs an instance that can be used to begin parsing `CodeUnit`s at
/// any Unicode scalar boundary.
init()
/// Parses a single Unicode scalar value from `input`.