Skip to content

Latest commit

 

History

History
71 lines (41 loc) · 1.96 KB

README.md

File metadata and controls

71 lines (41 loc) · 1.96 KB
Raw

RUST-APT

rust-apt provides bindings to libapt-pkg.

Currently rust-apt has most functionality available such as basic querying of package information, Installing and removing packages, updating the package lists and upgrading the system.

If you find something missing, please make an Issue to request the feature.

This API is subject to change at any time

rust-apt is stable for use, but breaking changes are possible. Breaking changes will be on the minor, never on the patch.

src/raw contains the direct C++ bindings to libapt-pkg that are defined in apt-pkg-c

These are generally considered safe, but may cause segfaults if you do something wrong. We offer no safety guarantees for using the raw bindings directly.

If you find a way to segfault without using the raw bindings directly, please report this as a bug.

Documentation and Examples

For more instructions on how to use rust-apt see our docs.rs page.

License Note

This crate is licensed under the GPLv3 or later.

Building

libapt-pkg-dev must be installed. Minimum supported version is 2.0.2.

Thread safety

It is not advised to use this crate in multiple threads.

You're free to try it but development will not be focused on making this crate thread safe.

Development

Make sure cargo and rustup are installed before you run the following commands.

You will need the stable and nightly toolchain. Nightly is only used for rustfmt.

Install just, a command runner we use to simplify some tasks.

cargo install just

Now that cargo and just are installed, You can setup your dev environment.

setup-dev will:

  • Install the necessary dependencies with apt.

  • Ensure the proper toolchains are installed with rustup.

  • Create compile_commands.json with bear for better c++ linting

just setup-dev

Before you commit, check formatting and basic code QA.

just fmt
just check