Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Keep Rust README minimal #390

Merged
merged 2 commits into from
Feb 22, 2019
Merged

Keep Rust README minimal #390

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd6e0c2
Keep Rust README minimal
ilammy Feb 22, 2019
8242d8f
Use "wrapper" instead of "binding" for consistency
ilammy Feb 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 17 additions & 83 deletions src/wrappers/themis/rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# rust-themis
# themis

[![crates.io][crates-io-badge]][crates-io]
[![CircleCI][circle-ci-badge]][circle-ci]
Expand All @@ -14,95 +14,29 @@ Rust binding for [Themis] crypto library.
[license]: LICENSE
[license-badge]: https://img.shields.io/crates/l/themis.svg

## Usage
## Quickstart

First you need to install the native Themis library.
Rust-Themis is a binding so it requires a native Themis library.
Please refer to [the quickstart guide] for installation instructions.

Then you simply add this to your Cargo.toml:
Documentation may be found here:

```toml
[dependencies]
themis = "0.0.3"
```
- [general documentation on our wiki][wiki]
- [in-depth documentation on our site][docserver]
- [Rust API documentation on docs.rs][docs.rs]
- [change log for versions on GitHub][CHANGELOG]

And you’re ready to go.
You can start off experimenting with [the examples].
You can start off experimenting with [the examples]
or take a look at [the tests]
to get a feeling of how Themis can be used.

[the quickstart guide]: /README.md#quickstart
[the quickstart guide]: https://github.com/cossacklabs/themis/wiki/Rust-Howto
[wiki]: https://github.com/cossacklabs/themis/wiki
[docs.rs]: https://docs.rs/themis
[docserver]: https://docs.cossacklabs.com/products/themis/
[CHANGELOG]: /src/wrappers/themis/rust/CHANGELOG.md
[the examples]: /docs/examples/rust

## Building

Rust-Themis is a binding so it requires a native Themis library.
After that all the usual Cargo commands like `cargo test` should work out-of-the-box.

### Native Themis library

The easiest way to make native Themis available is to install it into your system.
Please refer to [the quickstart guide] for installation instructions for your platform.
Once that’s done the build should complete successfully.

If the compilation fails with a message like this:

```
Compiling libthemis-sys v0.0.3
error: failed to run custom build command for `libthemis-sys v0.0.3`
process didn't exit successfully: `target/debug/build/libthemis-sys-ea820c7d68995088/build-script-build` (exit code: 101)
--- stdout
cargo:rerun-if-env-changed=LIBTHEMIS_NO_PKG_CONFIG

[ some lines omitted ]

cargo:rerun-if-env-changed=PKG_CONFIG_SYSROOT_DIR

--- stderr
thread 'main' panicked at '

`libthemis-sys` could not find Themis installation in your system.

[ some lines omitted ]

', libthemis-sys/build.rs:61:23
note: Run with `RUST_BACKTRACE=1` for a backtrace.
```

then please read the message carefully and help the build find your library.

We use **pkg-config** to locate the native Themis library.
Make sure you have this tool installed and correctly configured.
If you use a non-standard installation path
(e.g., `/opt/themis`)
then you need to set `PKG_CONFIG_PATH` environment variable
to the directory containing *.pc files
(e.g., `/opt/themis/lib/pkgconfig`).

### Tweaking the build

You can set other environment variables to control how pkg-config resolves native dependencies.

- `LIBTHEMIS_STATIC` — set to prefer static linking
- `LIBTHEMIS_DYNAMIC` — set to prefer dynamic linking

Refer to [the `pkg_config` documentation] for more information about available environment variables.

[the `pkg_config` documentation]: https://docs.rs/pkg-config/latest/pkg_config/

### 🍺 A note for Homebrew users

If you install Themis via `brew` on macOS then it will be using Homebrew’s OpenSSL libraries.
Homebrew does not install OpenSSL into default system location (it’s _keg-only_).
That’s because your system is likely to contain its own OpenSSL installation in default path
and Homebrew won’t replace it to avoid accidental breakage.

You need to tell pkg-config to use Homebrew’s OpenSSL
by setting `PKG_CONFIG_PATH` to the keg location of OpenSSL used by Themis.
You can usually find out where it is with a spell like this:

```console
$ find $(brew --prefix $(brew deps themis-openssl)) -follow -type d -name pkgconfig
/usr/local/opt/openssl/lib/pkgconfig
```
[the tests]: /tests/rust

## Licensing

Expand Down