Published Rust Bindings #2980
Merged
Published Rust Bindings #2980
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
September 18, 2019 12:59
- Describe the two ways of using the bindings
- Add some doc comments in lib.rs
Closed
markus2330
reviewed
Sep 24, 2019
| @@ -147,7 +147,7 @@ you up to date with the multi-language support provided by Elektra. | |||
|
|
|||
| - Add the `elektra-sys` crate which contains raw bindings to libelektra for Rust. _(Philipp Gackstatter)_ | |||
| - Add the `elektra` crate which contains safe wrapper methods for the raw bindings. The crate contains bindings for the low-level API, which means that the data types `Key` and `KeySet` can now safely be used from Rust. The Rust version of the API has been designed to take advantage of Rust's type system and to be in accordance with the memory safety of Rust. For instance, the Key has been divided into `StringKey` and `BinaryKey`, to prevent type mismatches at compile time. With the binding for `KDB`, one can take advantage of the elektra ecosystem from Rust. See the [Readme](../../src/bindings/rust/README.md) for more. _(Philipp Gackstatter)_ | |||
| - The [elektra](https://crates.io/crates/elektra) and [elektra-sys](https://crates.io/crates/elektra-sys) crates have been published to crates.io for easier usage. _(Philipp Gackstatter)_ | |||
There was a problem hiding this comment.
Why do you remove the links?
There was a problem hiding this comment.
They don't pass the link checker.
Somehow it returns a NotFound, and I don't think we can fix this.
$ curl https://crates.io/crate/elektra
{"errors":[{"detail":"Not Found"}]}
There was a problem hiding this comment.
Then put the links to the whitelist. They obviously work in the browser. (But beware of typos, in the curl statement above there is a typo: crate -> crates).
- Also update the published_build.rs script
markus2330
reviewed
Sep 24, 2019
| @@ -10,3 +10,5 @@ https://build.libelektra.org/jenkins/job/libelektra/pipeline-syntax | |||
| # see https://github.com/ElektraInitiative/libelektra/issues/2913 | |||
| http://webdemo.libelektra.org | |||
| https://webdemo.libelektra.org | |||
| https://crates.io/crates/elektra | |||
| https://crates.io/crates/elektra-sys | |||
There was a problem hiding this comment.
Does it work without new-line at the end?
There was a problem hiding this comment.
The link checker succeeded, so I guess it works.
|
Thank you, great work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Rust Bindings are now published to crates.io. Since there are some differences between what cmake requires and what I need for publishing, I had to add modified versions of
Cargo.tomlandbuild.rs. I also added some additional documentation in the elektra crate and added a short guide for publishing future crate versions.fixes #2730
Basics
Check relevant points but please do not remove entries.
Do not describe the purpose of this PR in the PR description but:
doc/news/_preparation_next_release.mdwhich contains_(my name)_)Please always add something to the the release notes.
(first line should have
module: short statementsyntax)close #X, should be in the commit messages.Checklist
Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar none of these points below
need to be checked.
Review
Reviewers will usually check the following:
Labels
say that everything is ready to be merged.