deb 0.5.20

Utilities for working with files and formats commonly found when working with Debian's project tooling, or infrastructure.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

// {{{ Copyright (c) Paul R. Tagliamonte <paultag@debian.org>, 2024
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE. }}}

#![deny(missing_docs)]
#![deny(missing_copy_implementations)]
#![deny(trivial_casts)]
#![deny(trivial_numeric_casts)]
#![deny(unused_import_braces)]
#![deny(unused_qualifications)]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! 🎉 You found the `deb` crate! 🎉
//!
//! <div class="warning">
//! This crate is under active development, and "soft launched". <b>Please do
//! not post widely directing users to this crate yet</b> -- the API shipped
//! today is unstable, and <i>will</i> change -- fairly significantly -- without
//! regard to following semver until it stabilizes.
//! </div>
//!
//! You're more than welcome to play with this and use it, but it's not
//! something I would encourage load bearing infrastructure to be written
//! with as of right now.
//!
//! # Introduction
//!
//! The `deb` crate contains utilities for working with files and formats
//! commonly found when working with Debian's project tooling, or
//! infrastructure.
//!
//! Common use-cases are broken out into modules in the `deb` crate namespace,
//! such as interacting with [control] files, parsing [dependency]
//! relationships between Debian packages, parsing and ordering [version]
//! numbers, or understanding Debian [architecture] strings.
//!
//! Docs can be found on [docs.rs](https://docs.rs/deb/latest/deb/),
//! and information about the latest release can be found on
//! [crates.io](https://crates.io/crates/deb).
//!
//! # Feature Flags
//!
//! There are a few feature flags. There's no standard way to document
//! the purpose and intent, so until that's a thing, here's a markdown
//! table.
//!
//! | Flag      | Description                                                              |
//! | --------- | ------------------------------------------------------------------------ |
//! | `full`    | Enable all optional features.                                            |
//! | `chrono`  | Enable parsing dates using the [chrono] crate.                           |
//! | `hex`     | Enable parsing ASCII hex values using the [hex] crate                    |
//! | `serde`   | Enable support for encoding and decoding using [serde]                   |
//! | `sequoia` | Enable support for validating OpenPGP signatures using [sequoia_openpgp] |
//! | `tokio`   | Enable support for the [tokio] crate.                                    |
//!
//! # Feature `chrono`
//!
//! Enable parsing dates from ASCII into a [chrono::DateTime].
//!
//! # Feature `hex`
//!
//! Enable parsing hashes from ASCII into bytes using the `hex` crate. This
//! is only really useful in places where you're validating things like
//! digests over files in [control::package::Changes] files, or similar.
//!
//! # Feature `serde`
//!
//! This exports two new modules for working with control files, [control::de],
//! and [control::ser] to read or write (respectively) control files in the
//! Debian RFC2822-style format, as is our convention.
//!
//! # Feature `sequoia`
//!
//! Enable functions to verify Debian control files using the [sequoia_openpgp]
//! OpenPGP implementation. This will export a few helpers throughout
//! the crate, such as [control::de::from_clearsigned_str].
//!
//! # Feature `tokio`
//!
//! Enable functions to handle places where there's an i/o boundary that is
//! handled by [tokio::io] rather than [std::io].

pub mod architecture;
pub mod build_profile;
pub mod control;
pub mod dependency;
pub mod release;
pub mod version;

pub(crate) mod errors;

// vim: foldmethod=marker