Skip to content

Commit d5f38b7

Browse files
committed
Add basic DocC files for modules
1 parent 2d43c71 commit d5f38b7

File tree

2 files changed

+77
-0
lines changed

2 files changed

+77
-0
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# ``RediStack``
2+
3+
A non-blocking Swift client for Redis built on top of SwiftNIO.
4+
5+
## Overview
6+
7+
**RediStack** is quick to use - all you need is an [`EventLoop`](https://apple.github.io/swift-nio/docs/current/NIO/Protocols/EventLoop.html) from **SwiftNIO**.
8+
9+
```swift
10+
import NIO
11+
import RediStack
12+
13+
let eventLoop: EventLoop = ...
14+
let connection = RedisConnection.make(
15+
configuration: try .init(hostname: "127.0.0.1"),
16+
boundEventLoop: eventLoop
17+
).wait()
18+
19+
let result = try connection.set("my_key", to: "some value")
20+
.flatMap { return connection.get("my_key") }
21+
.wait()
22+
23+
print(result) // Optional("some value")
24+
```
25+
26+
> Important: Use of `wait()` was used here for simplicity. Never call this method on an `eventLoop`!
27+
28+
## Topics
29+
30+
### Creating Connections
31+
32+
- ``RedisConnection``
33+
- ``RedisConnectionPool``
34+
35+
### Sending Commands
36+
37+
- ``RedisClient``
38+
- ``RedisCommand``
39+
- ``RedisKey``
40+
41+
### Pub/Sub
42+
43+
- ``RedisChannelName``
44+
45+
### Error Handling
46+
47+
- ``RedisError``
48+
- ``RedisClientError``
49+
- ``RedisConnectionPoolError``
50+
51+
### Monitoring
52+
53+
- ``RedisMetrics``
54+
- ``RedisLogging``
55+
56+
### Creating Redis NIO Pipelines
57+
58+
- ``RedisByteDecoder``
59+
- ``RedisCommandHandler``
60+
- ``RedisMessageEncoder``
61+
- ``RedisPubSubHandler``
62+
63+
### Redis Serialization Protocol
64+
65+
- ``RESPTranslator``
66+
- ``RESPValue``
67+
- ``RESPValueConvertible``
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ``RediStackTestUtils``
2+
3+
A collection of useful utilities for testing code that interacts with Redis.
4+
5+
## Topics
6+
7+
### Integration Tests
8+
9+
- ``RedisIntegrationTestCase``
10+
- ``RedisConnectionPoolIntegrationTestCase``

0 commit comments

Comments
 (0)