nebkor/julid-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix readme typo, add docs.rs metadata to build all features, bump version.

Browse source
This commit is contained in:
Joe Ardent 2023-07-28 07:11:56 -07:00
parent 2f5debc426
commit 2ffca693be
3 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
Cargo.toml
View file

@ -1,30 +1,36 @@
[package]
name = "julid-rs"
version = "1.6.1"
version = "1.6.18"
authors = ["Joe Ardent <code@ardent.nebcorp.com>"]
edition = "2021"
keywords = ["ulid", "library", "sqlite", "extension", "julid"]
description = "A library and loadable extension for SQLite that uses it, that provides Joe's ULIDs."
description = "A crate and loadable extension for SQLite that uses it, that provides Joe's ULIDs."
readme = "README.md"
license-file = "LICENSE.md"
repository = "https://gitlab.com/nebkor/julid"
[features]
default = ["chrono", "serde", "sqlx"] # just the regular crate
chrono = ["dep:chrono"]
plugin = ["sqlite-loadable"] # builds libjulid.* for loading into sqlite
serde = ["dep:serde"]
sqlx = ["dep:sqlx"]
# WARNING! don't enable this feature in your project's Cargo.toml if using julid-rs as a dependency;
# see https://gitlab.com/nebkor/julid/-/issues/1
plugin = ["sqlite-loadable"] # builds libjulid.* for loading into sqlite
[lib]
name = "julid"
crate-type = ["cdylib", "rlib"]
[dependencies]
rand = "0.8"
# all other deps are optional
chrono = { version = "0.4", optional = true, default-features = false, features = ["std", "time"] }
serde = { version = "1.0", features = ["derive"], optional = true }
sqlx = { version = "0.7", features = ["sqlite"], default-features = false, optional = true }
sqlite-loadable = { version = "0.0.5", optional = true }
chrono = { version = "0.4.26", optional = true, default-features = false, features = ["std", "time"] }
[package.metadata.docs.rs]
all-features = true

13
README.md
View file

@ -109,14 +109,14 @@ fn main() {
}
```
after adding it to your project's dependencies(eg, `cargo add julid-rs`; note the package name is
after adding it to your project's dependencies (eg, `cargo add julid-rs`; note the package name is
"julid-rs", but the library name as used in your `use` statements is just "julid"). By default, it
will also include trait implementations for using Julids with
[SQLx](https://github.com/launchbadge/sqlx), and serializing/deserializing with
[Serde](https://serde.rs/), via the `sqlx` and `serde` features, respectively. One final default
feature, `chrono`, uses the Chrono crate to return the timestamp as a
[`DateTime`](https://docs.rs/chrono/latest/chrono/struct.DateTime.html) by adding a `created_at()`
method to `Julid` instances.
optional feature, `chrono`, uses the Chrono crate to return the timestamp as a
[`DateTime`](https://docs.rs/chrono/latest/chrono/struct.DateTime.html) by adding a `created_at(&self)`
method to `Julid`.
# Thanks
@ -124,7 +124,4 @@ This crate wouldn't have been possible without a lot of inspiration (and a littl
stealing) from the [ulid-rs](https://github.com/dylanhart/ulid-rs) crate, as well as the
[sqlite-loadable-rs](https://github.com/asg017/sqlite-loadable-rs) crate, which made it *extremely*
easy to write the SQLite extension. Thank you, authors of those crates! Feel free to steal from this
project! (though I did submit a [pull request](https://github.com/asg017/sqlite-loadable-rs/pull/13)
to the sqlite-loadable-rs project, to add an entrypoint macro that returns
[`SQLITE_OK_LOAD_PERMANENTLY`](https://www.sqlite.org/rescode.html#ok_load_permanently), which would
let me use that instead of manually implementing the entrypoint to return that)
project!

2
VERSION
View file

@ -1 +1 @@
1.61
1.618