jq-sys 0.2.2

Generated bindings for libjq.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# jq-sys

[![crates.io](https://img.shields.io/crates/v/jq-sys.svg)](https://crates.io/crates/jq-sys)
[![crates.io](https://img.shields.io/crates/d/jq-sys.svg)](https://crates.io/crates/jq-sys)
[![docs.rs](https://docs.rs/jq-sys/badge.svg)](https://docs.rs/jq-sys)

Generated bindings for [jq] 1.6.

The bindings were generated with `bindgen`, which is available via
`cargo install`.

Example:

```
$ git submodule update --init
$ bindgen modules/jq/src/jq.h -o src/bindings.rs
```

## Building

### Using the bundled feature

When the `bundled` feature is enabled it will add a dependency on [jq-src], which
will attempt to build and link to the library. This may cover simple cases, but for
anything exotic (such as cross-building), you will want to install or build `libjq` 
yourself.

> Note: when using the `bundled` feature libjq is provided by
> the [jq-src] crate, which requires `gcc`, `autoreconf`, `make`, etc in
> your `PATH` to build.

### Without the bundled feature

When *not using* the `bundled` feature, you'd either have to compile `libjq` yourself, or use libs furnished by your
system package manager.

For example on **debian systems**, you might install `libjq1 libjq-dev libonig4 libonig-dev`.

The following env vars can be used to provide hints to the build script.

| Name | Purpose | Notes |
| --- | --- | --- |
| `JQ_LIB_DIR` | Path to the location of the library. ||
| `JQ_LIB_STATIC` | Use static linking instead of shared. ||
| `JQ_NO_ONIG` | Disable linking to `oniguruma` for regex support. ||
| `ONIG_LIB_DIR` | Path to the location of the library. | Defaults to `JQ_LIB_DIR`, ignored if `JQ_NO_ONIG` is set. |
| `ONIG_LIB_STATIC` | Use static linking instead of shared. | Ignored if `JQ_NO_ONIG` is set. |


> Note that if you are using the `pkg-config` feature and it is unable to locate `libjq`, can specify the location
> explicitly by setting `JQ_LIB_DIR`.
>
> This may be required on **debian** based distros (including **ubuntu**) since, at the time of writing, the
> distro packages for `jq` do not include the `.pc` files required for `pkg-config` to locate the files.

# Changelog

## 0.2.2 (2019-06-09)

- Update optional dep on [jq-src] to mitigate [build failures][jq-src#1] when
  using the `bundled` feature.

## 0.2.1 (2019-06-01)

- re-generated `src/bindings.rs` with `bindgen` v0.49.2.
- Updated dependency on [jq-src] to v0.3.
- Updated `build.rs` to avoid rebuilding jq from source more often than needed
  when using `bundled` feature ([#2]).

## 0.2.0 (2019-02-18)

Additions:

- New env vars added to allow linkage to `libjq` and `libonig` to be customized.
- Adds `pkg-config` feature (on by default) to help configure linkage, as a fallback when env vars are not set.

Breaking changes:

 - `bundled` feature is no longer enabled by default.

## 0.1.1 (2019-01-13)

Added `bundled` feature (on by default) to allow dependents to opt in or out
from using the [jq-src] crate for linkage.

## 0.1.0 (2019-01-13)

Initial release.


[jq-src]: https://crates.io/crate/jq-src
[jq]: https://github.com/stedolan/jq

[#2]: https://github.com/onelson/jq-sys/issues/2
[jq-src#1]: https://github.com/onelson/jq-src/issues/1