aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 702348be02357b11e3d095c52e110b225802ac23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Native rust implementation of the Quassel protocol and library functions

# Features

| Feature              | Description                                                                                                            |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| client               | Enable client side trait implementations                                                                               |
| server               | Enable server side trait implementations                                                                               |
| framing              | Enable support for tokio\'s [codec::Framed](url:https://docs.rs/tokio-util/latest/tokio_util/codec/struct.Framed.html) |
| all-quassel-features | enable all protocol features                                                                                           |
| long-message-id      | Serialize message IDs as i64                                                                                           |
| long-time            | Serialize Message Time as i64                                                                                          |
| rich-messages        | add avatar url and real name to messages                                                                               |
| sender-prefixes      | Show prefixes for senders in backlog                                                                                   |
| authenticators       | Support for exchangeable auth backends                                                                                 |
| bench                | Enable the test crate/feature for running benchmarks                                                                   |

# TODOs

## Road to 1.0

- [ ] Implementation of Syncable Objects
  - [X] AliasManager
  - [ ] BacklogManager
  - [X] BufferSyncer
  - [X] BufferViewConfig
  - [X] BufferViewManager
  - [X] CertManager
  - [X] CoreInfo
  - [X] HighlightRuleManager
  - [X] Identity
  - [X] IgnoreListManager
  - [X] IrcChannel
  - [ ] IrcListHelper
  - [X] IrcUser
  - [X] Network
  - [X] NetworkInfo
  - [X] NetworkConfig
- [X] Implement RPC Calls
  - [X] RPC Call Objects
  - [X] Serialization
- [ ] Rework Error handling to actually handle errors
- [ ] Rework Quassel feature flags to work at runtime, not compile time

## Nice to Have

- [ ] Rewrite the parsers using nom
- [ ] SessionManager
  - [ ] Automatic InitRequest handling in SessionManager
  - [ ] Add RPC Calls to SessionManager
dron-105/+55 this is due to the url shorterner dying randomly and also just generally bad idea to call external services during unit tests. 2021-10-20bump version to 1.6.2Max Audron-3/+2 2021-10-20prepare for release on crates.ioMax Audron-39/+65 2021-10-20add async docs to macro crate and bump versionMax Audron-9/+10 2021-10-20change hook errors to be logged as warningsMax Audron-3/+3 they in nearly all cases aren't critical enough to warrant an actual error messages 2021-10-20fix configuration not loading correctly on release buildsMax Audron-8/+23 2021-10-19replace sedregex crate8-rework-sedMax Audron-20/+358 This replaces the sedregex crate with our own implementation for multiple reasons: 1. We required to access the parsed regex, this required a patch to the sedregex crate which did not get merged due to an inactive dev, blocking us from publishing on crates.Io 2. We wanted to highlight the changes done in bold 3. We want to add execution of multiple chained sed commands in the future which would require more modification 2021-10-19add formatting trait for irc codesMax Audron-0/+129 add an impl off the formatting trait on String to format Strings with the typical irc formatting codes for bold, italic etc 2021-10-17fix links in readmeMax Audron-2/+2