Skip to content

Commit

Permalink
PubNub SDK 0.4.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
pubnub-release-bot committed Oct 16, 2023
1 parent 9dae854 commit 72504a3
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 33 deletions.
7 changes: 6 additions & 1 deletion .pubnub.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
name: rust
version: 0.3.0
version: 0.4.0
schema: 1
scm: github.com/pubnub/rust
files: []
changelog:
- date: 2023-10-16
version: 0.4.0
changes:
- type: feature
text: "Update the crypto module structure and add enhanced AES-CBC cryptor."
- date: 2023-08-30
version: 0.3.0
changes:
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "pubnub"
version = "0.3.0"
version = "0.4.0"
edition = "2021"
license = "MIT"
license-file = "LICENSE"
Expand Down
63 changes: 37 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
This is the official PubNub Rust SDK repository.

[PubNub](https://www.pubnub.com/) takes care of the infrastructure and APIs needed for the realtime
communication layer of your application. Work on your app's logic and let PubNub handle sending and receiving
data across the world in less than 100ms.
communication layer of your application. Work on your app's logic and let
PubNub handle sending and receiving data across the world in less than
100ms.

## Getting started

Expand All @@ -35,11 +36,11 @@ Add `pubnub` to your Rust project in the `Cargo.toml` file:
```toml
# default features
[dependencies]
pubnub = "0.3.0"
pubnub = "0.4.0"

# all features
[dependencies]
pubnub = { version = "0.3.0", features = ["full"] }
pubnub = { version = "0.4.0", features = ["full"] }
```

### Example
Expand Down Expand Up @@ -125,24 +126,25 @@ You can find more examples in our [examples](https://github.com/pubnub/rust/tree

## Features

The `pubnub` crate is split into multiple features. You can enable or disable them in the `Cargo.toml` file, like so:
The `pubnub` crate is split into multiple features. You can enable or
disable them in the `Cargo.toml` file, like so:

```toml
# only blocking and access + default features
[dependencies]
pubnub = { version = "0.3.0", features = ["blocking", "access"] }
pubnub = { version = "0.4.0", features = ["blocking", "access"] }

# only parse_token + default features
[dependencies]
pubnub = { version = "0.3.0", features = ["parse_token"] }
pubnub = { version = "0.4.0", features = ["parse_token"] }
```

### Available features

| Feature name | Description | Available PubNub APIs |
| :------------ | :---------- | :------------- |
| `full` | Enables all non-conflicting features | Configuration, Publish, Subscribe, Access Manager, Parse Token, Presence |
| `default` | Enables default features: `publish`, `subscribe`, `serde`, `reqwest`, `aescbc`, `std` | Configuration, Publish, Subscribe |
| `full` | Enables all non-conflicting features | Configuration, Publish, Subscribe, Access Manager, Parse Token, Presence, Crypto Module |
| `default` | Enables default features: `publish`, `subscribe`, `serde`, `reqwest`, `std` | Configuration, Publish, Subscribe |
| `publish` | Enables Publish API | Configuration, Publish |
| `access` | Enables Access Manager API | Configuration, Access Manager |
| `parse_token` | Enables parsing Access Manager tokens | Configuration, Parse Token |
Expand All @@ -152,7 +154,7 @@ pubnub = { version = "0.3.0", features = ["parse_token"] }
| `serde` | Uses [serde](https://github.com/serde-rs/serde) for serialization | n/a |
| `reqwest` | Uses [reqwest](https://github.com/seanmonstar/reqwest) as a transport layer | n/a |
| `blocking` | Enables blocking executions of APIs | n/a |
| `aescbc` | Enables AES-CBC encryption | n/a |
| `crypto` | Enables crypto module for data encryption and decryption | n/a |
| `std` | Enables `std` library | n/a |

## Documentation
Expand All @@ -162,52 +164,61 @@ pubnub = { version = "0.3.0", features = ["parse_token"] }

## Wasm support

The `pubnub` crate is compatible with WebAssembly. You can use it in your Wasm project.
The `pubnub` crate is compatible with WebAssembly. You can use it in your
Wasm project.

## `no_std` support

The `pubnub` crate is `no_std` compatible. To use it in a `no_std` environment, you have to disable the default
features and enable the ones you need, for example:
The `pubnub` crate is `no_std` compatible. To use it in a `no_std`
environment, you have to disable the default features and enable the ones
you need, for example:

```toml
[dependencies]
pubnub = { version = "0.3.0", default-features = false, features = ["serde", "publish",
pubnub = { version = "0.4.0", default-features = false, features = ["serde", "publish",
"blocking"] }
```

### Limitations

The `no_std` support is limited by the implementation details of the SDK.

The SDK uses the `alloc` crate to allocate memory for some operations, which means that
certain targets aren't supported. Additionally, as we provide a synchronous API, we use
some parts of the `alloc::sync` module, which is also not supported in certain `no_std` environments.
The SDK uses the `alloc` crate to allocate memory for some operations, which
means that certain targets aren't supported. Additionally, as we provide a
synchronous API, we use some parts of the `alloc::sync` module, which is
also not supported in certain `no_std` environments.

Some SDK features aren't supported in a `no_std` environment:

* partially `access` module (because of lack of timestamp support)
* partially `reqwest` transport (because of the reqwest implementation details)
* partially `subscribe` module (because of the spawning tasks and time dependence)
* partially `presence` module (because of the spawning tasks and time dependence)
* partially `reqwest` transport (because of the reqwest implementation
details)
* partially `subscribe` module (because of the spawning tasks and time
dependence)
* partially `presence` module (because of the spawning tasks and time
dependence)
* `std` feature (because of the `std` library)

We depend on a random number generator to generate data for debugging purposes.
If you want to use the SDK in a `no_std` environment, you'll have to provide
your own random number generator implementation for certain targets.
We depend on a random number generator to generate data for debugging
purposes. If you want to use the SDK in a `no_std` environment, you'll have
to provide your own random number generator implementation for certain
targets.

See more:

* [`getrandom` crate](https://docs.rs/getrandom/latest/getrandom/)
* [no_std examples](https://github.com/pubnub/rust/tree/master/examples/no_std/)

If you're having problems compiling this crate for more exotic targets, you can try to use the
`extra_platforms` feature. Be aware that this feature is **not supported** and we do not recommend using it.
If you're having problems compiling this crate for more exotic targets, you
can try to use the `extra_platforms` feature. Be aware that this feature is
**not supported** and we do not recommend using it.

For more information about this feature. refer to [Cargo.toml](https://github.com/pubnub/rust/blob/master/Cargo.toml) in the `[features]` section.

## Support

If you **need help** or have a **general question**, contact [email protected].
If you **need help** or have a **general question**, contact
[email protected].

## License

Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@
//! ```toml
//! # default features
//! [dependencies]
//! pubnub = "0.3.0"
//! pubnub = "0.4.0"
//!
//! # all features
//! [dependencies]
//! pubnub = { version = "0.3.0", features = ["full"] }
//! pubnub = { version = "0.4.0", features = ["full"] }
//! ```
//!
//! ### Example
Expand Down Expand Up @@ -135,11 +135,11 @@
//! ```toml
//! # only blocking and access + default features
//! [dependencies]
//! pubnub = { version = "0.3.0", features = ["blocking", "access"] }
//! pubnub = { version = "0.4.0", features = ["blocking", "access"] }
//!
//! # only parse_token + default features
//! [dependencies]
//! pubnub = { version = "0.3.0", features = ["parse_token"] }
//! pubnub = { version = "0.4.0", features = ["parse_token"] }
//! ```
//!
//! ### Available features
Expand Down Expand Up @@ -178,7 +178,7 @@
//!
//! ```toml
//! [dependencies]
//! pubnub = { version = "0.3.0", default-features = false, features = ["serde", "publish",
//! pubnub = { version = "0.4.0", default-features = false, features = ["serde", "publish",
//! "blocking"] }
//! ```
//!
Expand Down

0 comments on commit 72504a3

Please sign in to comment.