Skip to content

Commit 8d10327

Browse files
committed
Update docs and bump version [skip ci]
1 parent 4760353 commit 8d10327

File tree

4 files changed

+19
-15
lines changed

4 files changed

+19
-15
lines changed

CHANGELOG.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,24 @@ All changes in this project will be noted in this file.
99
### Added
1010

1111
- Support for DDL queries
12-
- Support for directly getting types from actions. For example:
12+
- Support for directly getting types from actions (this is required to be passed for actions
13+
that need them). For example:
1314
```rust
14-
let mut x: u64 = con.get("my integer key").unwrap();
15+
let x: u64 = con.get("my integer key").unwrap();
16+
let myval: Vec<String> = con.mget(["x", "y", "z"]).unwrap();
1517
```
1618
All errors resulting from this parse are simply propagated into the `Error::ParseError`
1719
variant
1820
- Support for retrieval of custom types through the use of the `FromSkyhashBytes` trait
1921

20-
### Broken
22+
### Breaking changes
2123

2224
- Errors have been unified into a single error type
2325
- Some types have been removed to aid simplicity:
2426
- `types::Str`
2527
- `types::SimpleArray`
28+
- The trait method `IntoSkyhashBytes::into_bytes` was renamed to `IntoSkyhashBytes::as_bytes()` to
29+
follow naming conventions
2630

2731
## Version 0.5.0
2832

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ license = "Apache-2.0"
99
name = "skytable"
1010
readme = "README.md"
1111
repository = "https://github.com/skytable/client-rust"
12-
version = "0.6.0-alpha.2"
12+
version = "0.6.0"
1313

1414
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1515

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ cargo new skyapp
2626
First add this to your `Cargo.toml` file:
2727

2828
```toml
29-
skytable = "0.6.0-alpha.2"
29+
skytable = "0.6.0"
3030
```
3131

3232
Now open up your `src/main.rs` file and establish a connection to the server while also adding some
@@ -88,7 +88,7 @@ Way to go &mdash; you're all set! Now go ahead and run more advanced queries!
8888

8989
The `default:default` keyspace has the following declaration:
9090

91-
```json
91+
```
9292
Keymap { data:(binstr,binstr), volatile:false }
9393
```
9494

@@ -118,7 +118,7 @@ You can also find the [latest examples here](https://github.com/skytable/client-
118118
If you need to use an `async` API, just change your import to:
119119

120120
```toml
121-
skytable = { version = "0.6.0-alpha.2", features=["async"], default-features = false }
121+
skytable = { version = "0.6.0", features=["async"], default-features = false }
122122
```
123123

124124
You can now establish a connection by using `skytable::AsyncConnection::new()`, adding `.await`s wherever
@@ -130,7 +130,7 @@ With this client driver, it is possible to use both sync and `async` APIs **at t
130130
this, simply change your import to:
131131

132132
```toml
133-
skytable = { version="0.6.0-alpha.2", features=["sync", "async"] }
133+
skytable = { version="0.6.0", features=["sync", "async"] }
134134
```
135135

136136
## TLS
@@ -140,15 +140,15 @@ If you need to use TLS features, this crate will let you do so with OpenSSL.
140140
### Using TLS with sync interfaces
141141

142142
```toml
143-
skytable = { version="0.6.0-alpha.2", features=["sync","ssl"] }
143+
skytable = { version="0.6.0", features=["sync","ssl"] }
144144
```
145145

146146
You can now use the async `sync::TlsConnection` object.
147147

148148
### Using TLS with async interfaces
149149

150150
```toml
151-
skytable = { version="0.6.0-alpha.2", features=["async","aio-ssl"], default-features=false }
151+
skytable = { version="0.6.0", features=["async","aio-ssl"], default-features=false }
152152
```
153153

154154
You can now use the async `aio::TlsConnection` object.

src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
//!
3939
//! First add this to your `Cargo.toml` file:
4040
//! ```toml
41-
//! skytable = "0.6.0-alpha.2"
41+
//! skytable = "0.6.0"
4242
//! ```
4343
//! Now open up your `src/main.rs` file and establish a connection to the server while also adding some
4444
//! imports:
@@ -125,7 +125,7 @@
125125
//!
126126
//! If you need to use an `async` API, just change your import to:
127127
//! ```toml
128-
//! skytable = { version = "0.6.0-alpha.2", features=["async"], default-features=false }
128+
//! skytable = { version = "0.6.0", features=["async"], default-features=false }
129129
//! ```
130130
//! You can now establish a connection by using `skytable::AsyncConnection::new()`, adding `.await`s wherever
131131
//! necessary. Do note that you'll the [Tokio runtime](https://tokio.rs).
@@ -135,7 +135,7 @@
135135
//! With this client driver, it is possible to use both sync and `async` APIs **at the same time**. To do
136136
//! this, simply change your import to:
137137
//! ```toml
138-
//! skytable = { version="0.6.0-alpha.2", features=["sync", "async"] }
138+
//! skytable = { version="0.6.0", features=["sync", "async"] }
139139
//! ```
140140
//!
141141
//! ## TLS
@@ -144,13 +144,13 @@
144144
//!
145145
//! ### Using TLS with sync interfaces
146146
//! ```toml
147-
//! skytable = { version="0.6.0-alpha.2", features=["sync","ssl"] }
147+
//! skytable = { version="0.6.0", features=["sync","ssl"] }
148148
//! ```
149149
//! You can now use the async [TlsConnection](`sync::TlsConnection`) object.
150150
//!
151151
//! ### Using TLS with async interfaces
152152
//! ```toml
153-
//! skytable = { version="0.6.0-alpha.2", features=["async","aio-ssl"], default-features=false }
153+
//! skytable = { version="0.6.0", features=["async","aio-ssl"], default-features=false }
154154
//! ```
155155
//! You can now use the async [TlsConnection](`aio::TlsConnection`) object.
156156
//!

0 commit comments

Comments
 (0)