Skip to content

Commit b799bc1

Browse files
committed
Adjust documentation and corresponding test
1 parent 1b91d29 commit b799bc1

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,25 +52,29 @@ let myRequestMessageUnpacked = try myRequestMessagePacket.message() // LSP.Mess
5252

5353
A client talking to an LSP server might need to extract `LSP.Packet`s from the server's output `Data` stream.
5454

55-
SwiftLSP can detect an `LSP.Packet` at the beginning of any `Data` instance and also offers the `LSP.PacketDetector` for parsing a stream of `Data` incrementally.
55+
SwiftLSP can parse an `LSP.Packet` from the beginning of a `Data` instance:
5656

5757
```swift
5858
let dataStartingWithPacket = packetTotalData + "Some other data".data(using: .utf8)!
59-
let parsedPacket = try LSP.Packet(parsingPrefixOf: dataStartingWithPacket)
59+
let detectedPacket = try LSP.Packet(parsingPrefixOf: dataStartingWithPacket)
6060

6161
// now parsedPacket == myRequestMessagePacket
62+
```
63+
64+
SwiftLSP also offers the `LSP.PacketDetector` for parsing a stream of `Data` incrementally:
6265

63-
var detectedPacket: LSP.Packet? = nil
66+
```swift
67+
var streamedPacket: LSP.Packet? = nil
6468

6569
let detector = LSP.PacketDetector { packet in
66-
detectedPacket = packet
70+
streamedPacket = packet
6771
}
6872

6973
for byte in dataStartingWithPacket {
7074
detector.read(Data([byte]))
7175
}
7276

73-
// now detectedPacket == myRequestMessagePacket
77+
// now streamedPacket == myRequestMessagePacket
7478
```
7579

7680
## More Use Cases

Tests/SwiftLSPTests.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,20 @@ final class SwiftLSPTests: XCTestCase {
2727
XCTAssertEqual(myRequestMessageUnpacked, myRequestMessage)
2828

2929
let dataStartingWithPacket = packetTotalData + "Some other data".data(using: .utf8)!
30-
let parsedPacket = try LSP.Packet(parsingPrefixOf: dataStartingWithPacket)
31-
XCTAssertEqual(parsedPacket, myRequestMessagePacket)
30+
let detectedPacket = try LSP.Packet(parsingPrefixOf: dataStartingWithPacket)
31+
XCTAssertEqual(detectedPacket, myRequestMessagePacket)
3232

33-
var detectedPacket: LSP.Packet? = nil
33+
var streamedPacket: LSP.Packet? = nil
3434

3535
let detector = LSP.PacketDetector { packet in
36-
detectedPacket = packet
36+
streamedPacket = packet
3737
}
3838

3939
for byte in dataStartingWithPacket {
4040
detector.read(Data([byte]))
4141
}
4242

43-
XCTAssertEqual(detectedPacket, myRequestMessagePacket)
43+
XCTAssertEqual(streamedPacket, myRequestMessagePacket)
4444
}
4545

4646
func testNewRequestMessageHasUUIDasID() throws {

0 commit comments

Comments
 (0)