debian_control/lib.rs
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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
#![deny(missing_docs)]
//! Parser for Debian control files.
//!
//! This crate provides a parser for Debian control files.
//!
//! # Example
//!
//! ```rust
//! use debian_control::lossy::Control;
//! use debian_control::fields::Priority;
//! use std::fs::File;
//!
//! let mut control = Control::new();
//! let mut source = &mut control.source;
//! source.name = "hello".to_string();
//! source.section = Some("rust".to_string());
//!
//! let mut binary = control.add_binary("hello");
//! binary.architecture = Some("amd64".to_string());
//! binary.priority = Some(Priority::Optional);
//! binary.description = Some("Hello, world!".to_string());
//!
//! assert_eq!(control.to_string(), r#"Source: hello
//! Section: rust
//!
//! Package: hello
//! Architecture: amd64
//! Priority: optional
//! Description: Hello, world!
//! "#);
//! ```
//!
//! See the ``lossless`` module for a parser that preserves all comments and formatting, and
//! as well as allowing inline errors.
pub mod lossy;
pub use lossless::control::{Binary, Control, Source};
pub mod fields;
pub use fields::*;
pub mod lossless;
pub use lossless::apt;
pub use lossless::changes;
pub use lossless::control;
pub mod pgp;
pub mod relations;
pub mod vcs;
use std::borrow::Cow;
/// Error type for parsing an identity string.
#[derive(Debug, PartialEq)]
pub enum ParseIdentityError {
/// No email address found.
NoEmail,
}
impl std::fmt::Display for ParseIdentityError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
ParseIdentityError::NoEmail => write!(f, "No email found"),
}
}
}
impl std::error::Error for ParseIdentityError {}
/// Parse an identity string into a name and an email address.
///
/// The input string should be in the format `Name <email>`. If the email is missing, an error is
/// returned.
///
/// # Example
/// ```
/// use debian_control::parse_identity;
/// assert_eq!(parse_identity("Joe Example <joe@example.com>"), Ok(("Joe Example", "joe@example.com")));
/// ```
///
/// # Arguments
/// * `s` - The input string.
///
/// # Returns
/// A tuple with the name and the email address.
pub fn parse_identity(s: &str) -> Result<(&str, &str), ParseIdentityError> {
// Support Name <email> and email, but ensure email contains an "@".
if let Some((name, email)) = s.split_once('<') {
if let Some(email) = email.strip_suffix('>') {
Ok((name.trim(), email.trim()))
} else {
Err(ParseIdentityError::NoEmail)
}
} else if s.contains('@') {
Ok(("", s.trim()))
} else {
Err(ParseIdentityError::NoEmail)
}
}
/// A trait for looking up versions of packages.
pub trait VersionLookup {
/// Look up the version of a package.
fn lookup_version<'a>(
&'a self,
package: &'_ str,
) -> Option<std::borrow::Cow<'a, debversion::Version>>;
}
impl VersionLookup for std::collections::HashMap<String, debversion::Version> {
fn lookup_version<'a>(&'a self, package: &str) -> Option<Cow<'a, debversion::Version>> {
self.get(package).map(Cow::Borrowed)
}
}
impl<F> VersionLookup for F
where
F: Fn(&str) -> Option<debversion::Version>,
{
fn lookup_version<'a>(&'a self, name: &str) -> Option<Cow<'a, debversion::Version>> {
self(name).map(Cow::Owned)
}
}
impl VersionLookup for (String, debversion::Version) {
fn lookup_version<'a>(&'a self, name: &str) -> Option<Cow<'a, debversion::Version>> {
if name == self.0 {
Some(Cow::Borrowed(&self.1))
} else {
None
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_parse_identity() {
assert_eq!(
parse_identity("Joe Example <joe@example.com>"),
Ok(("Joe Example", "joe@example.com"))
);
assert_eq!(
parse_identity("joe@example.com"),
Ok(("", "joe@example.com"))
);
assert_eq!(parse_identity("somebody"), Err(ParseIdentityError::NoEmail));
}
}