vato007/SwiftSerial
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adjust readbyte documentation

Browse Source
This commit is contained in:
Yeo Kheng Meng
2017-06-24 17:54:36 +08:00
parent 5536368ba7
commit f3c3a214e3
2 changed files with 518 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -196,10 +196,15 @@ func readUntilChar(_ terminator: CChar) throws -> String
``` ```
Keep reading until the specified CChar is encountered. Return the string read so far without that value. Keep reading until the specified CChar is encountered. Return the string read so far without that value.
```swift
func readByte() throws -> UInt8
```
Read only one byte. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readBytes()`.
```swift ```swift
func readChar() throws -> UnicodeScalar func readChar() throws -> UnicodeScalar
``` ```
Read only one character. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readBytes()`. Read only one character. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readByte()`.
### Writing data to the port ### Writing data to the port