From 3e4b905e7b791d3afc0813c4e72c34e50d1fec6c Mon Sep 17 00:00:00 2001 From: Yeo Kheng Meng Date: Sat, 29 Oct 2016 17:48:52 +0800 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ec9150c..efc7e0e 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,11 @@ func readUntilChar(_ terminator: CChar) throws -> String ``` Keep reading until the specified CChar is encountered. Return the string read so far without that value. +```swift +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()`. + ### Writing data to the port There are several functions you can use to write data. All functions here are blocking till all the data has been written. All functions can throw `PortError.mustBeOpen`. @@ -185,6 +190,11 @@ func writeBytes(from buffer: UnsafeMutablePointer, size: Int) throws -> I ``` Function for those that want to mess with unsafe pointers. You have to specify how many bytes have to be written. Will return how many bytes actually written. +```swift +func writeChar(_ character: UnicodeScalar) throws -> Int{ +``` +Writes only one character. Will return `1` if successful. This function internally calls `writeString()`. Pull requests for a better way of doing this is appreciated. + ### Closing the port Just do `serialPort.closePort()` to close the port once you are done using it.