pub struct DebianSourceControlFile<'a> { /* private fields */ }Expand description
A Debian source control file/paragraph.
This control file consists of a single paragraph and defines a source package.
This paragraph is typically found in .dsc files and in Sources files in repositories.
The fields are defined at https://www.debian.org/doc/debian-policy/ch-controlfields.html#debian-source-control-files-dsc.
Implementations§
Source§impl<'a> DebianSourceControlFile<'a>
impl<'a> DebianSourceControlFile<'a>
Sourcepub fn from_reader<R: BufRead>(reader: R) -> Result<Self>
pub fn from_reader<R: BufRead>(reader: R) -> Result<Self>
Construct an instance by reading data from a reader.
The source must be a Debian source control file with exactly 1 paragraph.
The source must not be PGP armored (e.g. beginning with
-----BEGIN PGP SIGNED MESSAGE-----). For PGP armored data, use
Self::from_armored_reader().
Sourcepub fn from_armored_reader<R: BufRead>(reader: R) -> Result<Self>
pub fn from_armored_reader<R: BufRead>(reader: R) -> Result<Self>
Construct an instance by reading data from a reader containing a PGP cleartext signature.
This can be used to parse content from a .dsc file which begins
with -----BEGIN PGP SIGNED MESSAGE-----.
An error occurs if the PGP cleartext file is not well-formed or if a PGP parsing error occurs.
The PGP signature is NOT validated. The file will be parsed despite lack of signature verification. This is conceptually insecure. But since Rust has memory safety, some risk is prevented.
Sourcepub fn clone_no_signatures(&self) -> Self
pub fn clone_no_signatures(&self) -> Self
Clone without preserving signatures data.
Sourcepub fn signatures(&self) -> Option<&CleartextSignatures>
pub fn signatures(&self) -> Option<&CleartextSignatures>
Obtain PGP signatures from this possibly signed file.
Sourcepub fn format(&self) -> Result<&str>
pub fn format(&self) -> Result<&str>
The format of the source package.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-format.
Sourcepub fn source(&self) -> Result<&str>
pub fn source(&self) -> Result<&str>
The name of the source package.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source.
Sourcepub fn binary(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn binary(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
The binary packages this source package produces.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-binary.
Sourcepub fn architecture(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn architecture(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
The architectures this source package will build for.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-architecture.
Sourcepub fn version_str(&self) -> Result<&str>
pub fn version_str(&self) -> Result<&str>
The version number of the package as a string.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version.
Sourcepub fn version(&self) -> Result<PackageVersion>
pub fn version(&self) -> Result<PackageVersion>
The parsed version of the source package.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version.
Sourcepub fn maintainer(&self) -> Result<&str>
pub fn maintainer(&self) -> Result<&str>
The package maintainer.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-maintainer.
Sourcepub fn uploaders(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn uploaders(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>>
The list of uploaders and co-maintainers.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-uploaders.
Sourcepub fn homepage(&self) -> Option<&str>
pub fn homepage(&self) -> Option<&str>
The URL from which the source of this package can be obtained.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-homepage.
Sourcepub fn dgit(&self) -> Option<&str>
pub fn dgit(&self) -> Option<&str>
Describes the Git source from which this package came.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-dgit.
Sourcepub fn standards_version(&self) -> Result<&str>
pub fn standards_version(&self) -> Result<&str>
The most recent version of the standards this package conforms to.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-standards-version.
Sourcepub fn depends(&self) -> Option<Result<DependencyList>>
pub fn depends(&self) -> Option<Result<DependencyList>>
The Depends field, parsed to a DependencyList.
Sourcepub fn recommends(&self) -> Option<Result<DependencyList>>
pub fn recommends(&self) -> Option<Result<DependencyList>>
The Recommends field, parsed to a DependencyList.
Sourcepub fn suggests(&self) -> Option<Result<DependencyList>>
pub fn suggests(&self) -> Option<Result<DependencyList>>
The Suggests field, parsed to a DependencyList.
Sourcepub fn enhances(&self) -> Option<Result<DependencyList>>
pub fn enhances(&self) -> Option<Result<DependencyList>>
The Enhances field, parsed to a DependencyList.
Sourcepub fn pre_depends(&self) -> Option<Result<DependencyList>>
pub fn pre_depends(&self) -> Option<Result<DependencyList>>
The Pre-Depends field, parsed to a DependencyList.
Sourcepub fn package_dependency_fields(&self) -> Result<PackageDependencyFields>
pub fn package_dependency_fields(&self) -> Result<PackageDependencyFields>
Obtain parsed values of all fields defining dependencies.
Sourcepub fn package_list(
&self,
) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFilePackage<'_>>> + '_>>
pub fn package_list( &self, ) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFilePackage<'_>>> + '_>>
Packages that can be built from this source package.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-package-list.
Sourcepub fn checksums_sha1(
&self,
) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
pub fn checksums_sha1( &self, ) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
List of associated files with SHA-1 checksums.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-checksums.
Sourcepub fn checksums_sha256(
&self,
) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
pub fn checksums_sha256( &self, ) -> Option<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
List of associated files with SHA-256 checksums.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-checksums.
Sourcepub fn files(
&self,
) -> Result<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
pub fn files( &self, ) -> Result<Box<dyn Iterator<Item = Result<DebianSourceControlFileEntry<'_>>> + '_>>
List of associated files with MD5 checksums.
See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-files.
Sourcepub fn file_fetches(
&self,
checksum: ChecksumType,
) -> Result<Box<dyn Iterator<Item = Result<DebianSourceControlFileFetch>> + '_>>
pub fn file_fetches( &self, checksum: ChecksumType, ) -> Result<Box<dyn Iterator<Item = Result<DebianSourceControlFileFetch>> + '_>>
Obtain DebianSourceControlFileFetch for a given digest variant.
This obtains records that instruct how to fetch the files that compose this source package.
Methods from Deref<Target = ControlParagraph<'a>>§
Sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Whether the paragraph is empty.
Empty is defined by the lack of any fields.
Sourcepub fn set_field(&mut self, field: ControlField<'a>)
pub fn set_field(&mut self, field: ControlField<'a>)
Set the value of a field via a ControlField.
If a field with the same name (case insensitive compare) already exists, the old value will be replaced by the incoming value.
Sourcepub fn set_field_from_string(&mut self, name: Cow<'a, str>, value: Cow<'a, str>)
pub fn set_field_from_string(&mut self, name: Cow<'a, str>, value: Cow<'a, str>)
Set the value of a field defined via strings.
If a field with the same name (case insensitive compare) already exists, the old value will be replaced by the incoming value.
Sourcepub fn has_field(&self, name: &str) -> bool
pub fn has_field(&self, name: &str) -> bool
Whether a named field is present in this paragraph.
Sourcepub fn iter_fields(&self) -> impl Iterator<Item = &ControlField<'a>>
pub fn iter_fields(&self) -> impl Iterator<Item = &ControlField<'a>>
Iterate over fields in this paragraph.
Iteration order is insertion order.
Sourcepub fn field(&self, name: &str) -> Option<&ControlField<'a>>
pub fn field(&self, name: &str) -> Option<&ControlField<'a>>
Obtain the field with a given name in this paragraph.
Sourcepub fn field_mut(&mut self, name: &str) -> Option<&'a mut ControlField<'_>>
pub fn field_mut(&mut self, name: &str) -> Option<&'a mut ControlField<'_>>
Obtain a mutable reference to the field with a given name.
Sourcepub fn required_field(&self, name: &str) -> Result<&ControlField<'a>>
pub fn required_field(&self, name: &str) -> Result<&ControlField<'a>>
Obtain the named field and error if it isn’t defined.
Sourcepub fn field_str(&self, name: &str) -> Option<&str>
pub fn field_str(&self, name: &str) -> Option<&str>
Obtain the raw string value of the named field.
Sourcepub fn required_field_str(&self, name: &str) -> Result<&str>
pub fn required_field_str(&self, name: &str) -> Result<&str>
Obtain the raw string value of the named field, erroring if the field is not present.
Sourcepub fn field_bool(&self, name: &str) -> Option<bool>
pub fn field_bool(&self, name: &str) -> Option<bool>
Obtain the value of a field, evaluated as a boolean.
The field is true iff its string value is yes.
Sourcepub fn field_u64(&self, name: &str) -> Option<Result<u64>>
pub fn field_u64(&self, name: &str) -> Option<Result<u64>>
Obtain the value of a field, evaluated as a u64.
Sourcepub fn field_dependency_list(
&self,
name: &str,
) -> Option<Result<DependencyList>>
pub fn field_dependency_list( &self, name: &str, ) -> Option<Result<DependencyList>>
Obtain the value of a field, parsed as a DependencyList.
Sourcepub fn field_datetime_rfc5322(
&self,
name: &str,
) -> Option<Result<DateTime<Utc>>>
pub fn field_datetime_rfc5322( &self, name: &str, ) -> Option<Result<DateTime<Utc>>>
Obtain the value of a field parsed as an RFC 5322 date string.
This will parse values like Sat, 09 Oct 2021 09:34:56 UTC.
The timezone is always normalized to UTC even if it is expressed differently in the source string.
Sourcepub fn field_simple(&self, name: &str) -> Option<Result<ControlFieldValue<'a>>>
pub fn field_simple(&self, name: &str) -> Option<Result<ControlFieldValue<'a>>>
Obtain the field with the given name as a ControlFieldValue::Simple, if possible.
Sourcepub fn field_folded(&self, name: &str) -> Option<ControlFieldValue<'a>>
pub fn field_folded(&self, name: &str) -> Option<ControlFieldValue<'a>>
Obtain the field with the given name as a ControlFieldValue::Folded.
Sourcepub fn field_multiline(&self, name: &str) -> Option<ControlFieldValue<'a>>
pub fn field_multiline(&self, name: &str) -> Option<ControlFieldValue<'a>>
Obtain the field with the given name as a ControlFieldValue::Multiline.
Sourcepub fn iter_field_words(
&self,
name: &str,
) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn iter_field_words( &self, name: &str, ) -> Option<Box<dyn Iterator<Item = &str> + '_>>
Obtain an iterator of words in the named field.
Sourcepub fn iter_field_lines(
&self,
name: &str,
) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn iter_field_lines( &self, name: &str, ) -> Option<Box<dyn Iterator<Item = &str> + '_>>
Obtain an iterator of lines in the named field.
Sourcepub fn iter_field_comma_delimited(
&self,
name: &str,
) -> Option<Box<dyn Iterator<Item = &str> + '_>>
pub fn iter_field_comma_delimited( &self, name: &str, ) -> Option<Box<dyn Iterator<Item = &str> + '_>>
Obtain an iterator of comma-delimited values in the named field.
Sourcepub fn as_str_hash_map(&self) -> HashMap<&str, &str>
pub fn as_str_hash_map(&self) -> HashMap<&str, &str>
Convert this paragraph to a HashMap.
Values will be the string normalization of the field value, including newlines and leading whitespace.
If a field occurs multiple times, its last value will be recorded in the returned map.
Sourcepub fn write<W: Write>(&self, writer: &mut W) -> Result<()>
pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>
Serialize the paragraph to a writer.
A trailing newline is written as part of the final field. However, an extra newline is not present. So if serializing multiple paragraphs, an additional line break must be written to effectively terminate this paragraph if the writer is not at EOF.