apt-pkg-native/README.md
2017-10-15 21:05:14 +01:00

47 lines
1.6 KiB
Markdown

This crate provides bindings to `libapt-pkg`.
[![Build status](https://api.travis-ci.org/FauxFaux/apt-pkg-native-rs.png)](https://travis-ci.org/FauxFaux/apt-pkg-native-rs)
[![](http://meritbadge.herokuapp.com/apt-pkg-native)](https://crates.io/crates/apt-pkg-native)
### Documentation and Examples
See the `examples/` folder for some partial implementations of some commands.
https://docs.rs/apt-pkg-native
### License Note
While the code in this crate is available under a permissive MIT license,
it is useless without [`libapt-pkg`](https://tracker.debian.org/pkg/apt),
which is GPL2+.
### Building
`libapt-pkg-dev` must be installed. The [`gcc`](https://crates.io/crates/gcc)
crate is used to try and find a native compiler.
### Thread safety
It is intended that the crate should be usable from multiple threads.
However, this is generally implemented using singletons, which may be really
annoying for your use-case.
`apt` does not have a concurrency model: you may not use threads.
Since `apt` 1.4 or 1.5 (in Debian Stretch (2017), but not in Xenial 16.04),
some operations are thread safe: it should be possible to initialise the cache
twice in parallel. As these versions of `apt` are not widespread, the API of
this crate does not attempt to expose this.
### Switching distro with `docker`
`examples/on-sid` has a docker file which builds a minimum Debian image with
typical package lists downloaded. You can run a tool in it, from this directory,
by:
```
(cd examples/on-sid && make)
docker run -v $(pwd):/mnt sid-sources-list /mnt/target/release/examples/sources
```