Struct debian_packaging::binary_package_control::BinaryPackageControlFile

pub struct BinaryPackageControlFile<'a> { /* private fields */ }

A Debian binary package control file/paragraph.

See https://www.debian.org/doc/debian-policy/ch-controlfields.html#binary-package-control-files-debian-control.

Binary package control files are defined by a single paragraph with well-defined fields. This type is a low-level wrapper around an inner ControlParagraph. Deref and DerefMut can be used to operate on the inner ControlParagraph. From and Into are implemented in both directions to enable cheap coercion between the types.

Binary package control paragraphs are seen in DEBIAN/control files. Variations also exist in Packages files in repositories and elsewhere.

Fields annotated as mandatory in the Debian Policy Manual have getters that return Result and will error if a field is not present. Non-mandatory fields return Option. This enforcement can be bypassed by calling ControlParagraph::field().

Implementations

impl<'a> BinaryPackageControlFile<'a>

pub fn package(&self) -> Result<&str>

The Package field value.

pub fn version_str(&self) -> Result<&str>

The Version field as its original string.

pub fn version(&self) -> Result<PackageVersion>

The Version field parsed into a PackageVersion.

pub fn architecture(&self) -> Result<&str>

The Architecture field.

pub fn maintainer(&self) -> Result<&str>

The Maintainer field.

pub fn description(&self) -> Result<&str>

The Description field.

pub fn source(&self) -> Option<&str>

The Source field.

pub fn section(&self) -> Option<&str>

The Section field.

pub fn priority(&self) -> Option<&str>

The Priority field.

pub fn essential(&self) -> Option<&str>

The Essential field.

pub fn homepage(&self) -> Option<&str>

The Homepage field.

pub fn installed_size(&self) -> Option<Result<u64>>

The Installed-Size field, parsed to a u64.

pub fn size(&self) -> Option<Result<u64>>

The Size field, parsed to a u64.

pub fn built_using(&self) -> Option<&str>

The Built-Using field.

pub fn depends(&self) -> Option<Result<DependencyList>>

The Depends field, parsed to a DependencyList.

pub fn recommends(&self) -> Option<Result<DependencyList>>

The Recommends field, parsed to a DependencyList.

pub fn suggests(&self) -> Option<Result<DependencyList>>

The Suggests field, parsed to a DependencyList.

pub fn enhances(&self) -> Option<Result<DependencyList>>

The Enhances field, parsed to a DependencyList.

pub fn pre_depends(&self) -> Option<Result<DependencyList>>

The Pre-Depends field, parsed to a DependencyList.

pub fn package_dependency_fields(&self) -> Result<PackageDependencyFields>

Obtain parsed values of all fields defining dependencies.

Methods from Deref<Target = ControlParagraph<'a>>

pub fn is_empty(&self) -> bool

Whether the paragraph is empty.

Empty is defined by the lack of any fields.

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.

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.

pub fn has_field(&self, name: &str) -> bool

Whether a named field is present in this paragraph.

pub fn iter_fields(&self) -> impl Iterator<Item = &ControlField<'a>>

Iterate over fields in this paragraph.

Iteration order is insertion order.

pub fn field(&self, name: &str) -> Option<&ControlField<'a>>

Obtain the field with a given name in this paragraph.

pub fn field_mut(&mut self, name: &str) -> Option<&'a mut ControlField<'_>>

Obtain a mutable reference to the field with a given name.

pub fn required_field(&self, name: &str) -> Result<&ControlField<'a>>

Obtain the named field and error if it isn’t defined.

pub fn field_str(&self, name: &str) -> Option<&str>

Obtain the raw string value of the named field.

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.

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.

pub fn field_u64(&self, name: &str) -> Option<Result<u64>>

Obtain the value of a field, evaluated as a u64.

pub fn field_dependency_list(&self, name: &str) -> Option<Result<DependencyList>>

Obtain the value of a field, parsed as a DependencyList.

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.

pub fn field_simple(&self, name: &str) -> Option<Result<ControlFieldValue<'a>>>

Obtain the field with the given name as a ControlFieldValue::Simple, if possible.

pub fn field_folded(&self, name: &str) -> Option<ControlFieldValue<'a>>

Obtain the field with the given name as a ControlFieldValue::Folded.

pub fn field_multiline(&self, name: &str) -> Option<ControlFieldValue<'a>>

Obtain the field with the given name as a ControlFieldValue::Multiline.

pub fn iter_field_words(
    &self,
    name: &str
) -> Option<Box<dyn Iterator<Item = &str> + '_>>

Obtain an iterator of words in the named field.

pub fn iter_field_lines(
    &self,
    name: &str
) -> Option<Box<dyn Iterator<Item = &str> + '_>>

Obtain an iterator of lines in the named field.

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.

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.

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.

Trait Implementations

impl<'a> Clone for BinaryPackageControlFile<'a>

fn clone(&self) -> BinaryPackageControlFile<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'cf, 'a: 'cf> DebPackageReference<'cf> for BinaryPackageControlFile<'a>

fn deb_size_bytes(&self) -> Result<u64>

Obtain the size in bytes of the .deb file.

fn deb_digest(&self, checksum: ChecksumType) -> Result<ContentDigest>

Obtains the binary digest of this file given a checksum flavor.

fn deb_filename(&self) -> Result<String>

Obtain the filename of this .deb.

fn control_file_for_packages_index(
    &self
) -> Result<BinaryPackageControlFile<'cf>>

Obtain a BinaryPackageControlFile representing content for a Packages index file.

impl<'a> Debug for BinaryPackageControlFile<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Deref for BinaryPackageControlFile<'a>

type Target = ControlParagraph<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for BinaryPackageControlFile<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> From<BinaryPackageControlFile<'a>> for ControlParagraph<'a>

fn from(cf: BinaryPackageControlFile<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ControlParagraph<'a>> for BinaryPackageControlFile<'a>

fn from(paragraph: ControlParagraph<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for BinaryPackageControlFile<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for BinaryPackageControlFile<'a>

fn cmp(&self, other: &BinaryPackageControlFile<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<'a> PartialEq<BinaryPackageControlFile<'a>> for BinaryPackageControlFile<'a>

fn eq(&self, other: &BinaryPackageControlFile<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BinaryPackageControlFile<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<BinaryPackageControlFile<'a>> for BinaryPackageControlFile<'a>

fn partial_cmp(&self, other: &BinaryPackageControlFile<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for BinaryPackageControlFile<'a>

impl<'a> StructuralEq for BinaryPackageControlFile<'a>

impl<'a> StructuralPartialEq for BinaryPackageControlFile<'a>