Struct DebPackage

pub struct DebPackage { /* private fields */ }

A high-level structure representing a Deb package.

For binary package’s, it may be helpful to read Debian’s documentation on binary packages’ metadata.

As well, you can read Debian’s definition for the package’s maintainer scripts.

Implementations

impl DebPackage

pub fn new(name: &str) -> Self

Creates a new DebPackage with name as it’s name.

pub fn from<R: Read>(input: R) -> Result<Self>

Reads a DebPackage from input.

pub fn set_name(self, name: &str) -> Self

Sets the package’s name.

pub fn set_version(self, version: &str) -> Self

Sets the package’s version.

pub fn set_priority(self, priority: DebPriority) -> Self

Sets the package’s priority.

pub fn set_architecture(self, architecture: DebArchitecture) -> Self

Sets the package’s architecture.

pub fn set_essential(self, essential: bool) -> Self

Sets whether the package is essential.

pub fn with_depend(self, depend: &str) -> Self

Adds a single dependency from &str.

pub fn with_depends(self, depends: Vec<&str>) -> Self

Adds a number of dependencies from Vec<&str>.

pub fn no_depends(self) -> Self

Resets dependencies.

pub fn with_pre_depend(self, depend: &str) -> Self

Adds a single pre-dependency from &str.

pub fn with_pre_depends(self, depends: Vec<&str>) -> Self

Adds a number of pre-dependencies from Vec<&str>.

pub fn no_pre_depends(self) -> Self

Resets pre-dependencies.

pub fn with_recommend(self, recommend: &str) -> Self

Adds a single recommend from &str.

pub fn with_recommends(self, recommends: Vec<&str>) -> Self

Adds a number of recommends from Vec<&str>.

pub fn no_recommends(self) -> Self

Resets recommends.

pub fn with_suggest(self, suggest: &str) -> Self

Adds a single suggest from &str.

pub fn with_suggests(self, suggests: Vec<&str>) -> Self

Adds a number of suggests from Vec<&str>.

pub fn no_suggests(self) -> Self

Resets suggests.

pub fn with_break(self, conflict: &str) -> Self

Adds a single break from &str.

pub fn with_breaks(self, conflicts: Vec<&str>) -> Self

Adds a number of breaks from Vec<&str>.

pub fn no_breaks(self) -> Self

Resets breaks.

pub fn with_conflict(self, conflict: &str) -> Self

Adds a single conflict from &str.

pub fn with_conflicts(self, conflicts: Vec<&str>) -> Self

Adds a number of conflicts from Vec<&str>.

pub fn no_conflicts(self) -> Self

Resets conflicts.

pub fn with_provide(self, provide: &str) -> Self

Adds a single provide from &str.

pub fn with_provides(self, provides: Vec<&str>) -> Self

Adds a number of provides from Vec<&str>.

pub fn no_provides(self) -> Self

Resets provides.

pub fn with_replace(self, replace: &str) -> Self

Adds a single replace from &str.

pub fn with_replaces(self, replaces: Vec<&str>) -> Self

Adds a number of replaces from Vec<&str>.

pub fn no_replaces(self) -> Self

Resets replaces.

pub fn with_enhance(self, enhance: &str) -> Self

Adds a single enhance from &str.

pub fn with_enhances(self, enhances: Vec<&str>) -> Self

Adds a number of enhances from Vec<&str>.

pub fn no_enhances(self) -> Self

Resets enhances.

pub fn set_maintainer(self, maintainer: &str) -> Self

Sets the package’s maintainer.

pub fn set_description(self, description: &str) -> Self

Sets the package’s description.

pub fn set_homepage(self, homepage: &str) -> Self

Sets the package’s homepage.

pub fn with_built_using(self, using: &str, version: &str) -> Self

Adds a “built using” package.

pub fn no_built_using(self) -> Self

Resets built-using.

pub fn with_file(self, file: DebFile) -> Self

Adds a file to the package.

pub fn with_dir<P>(self, from: P, to: P) -> Result<Self>

where P: AsRef<Path>,

Recursively adds directory from to package as to.

This adds all files and sub-directories to to. For example, if you had a directory test containing the files foo and bar, then you can add those files as /usr/bin/foo and /usr/bin/bar with with_dir("test", "/usr/bin")?;

This function isn’t available when compiling on Windows, as it’s utility relies on being able to read the modes of the directory’s children, which is a feature Windows lacks.

Errors

This function may return an error if from doesn’t exist.

Example

use deb_rust::binary::DebPackage;

let mut package = DebPackage::new("example")
    .with_dir("test", "/usr/bin").unwrap();

pub fn clear_files(self) -> Self

Removes all file’s from the package.

pub fn config_from_str(self, script: &str) -> Self

Sets config script from &str.

pub fn config_from_buf(self, script: Vec<u8>) -> Self

Sets config script from Vec.

pub fn no_config(self) -> Self

Resets config script.

pub fn preinst_from_str(self, script: &str) -> Self

Sets preinst script from &str.

pub fn preinst_from_buf(self, script: Vec<u8>) -> Self

Sets preinst script from Vec.

pub fn no_preinst(self) -> Self

Resets preinst script.

pub fn postinst_from_str(self, script: &str) -> Self

Sets postinst script from &str.

pub fn postinst_from_buf(self, script: Vec<u8>) -> Self

Sets postinst script from Vec.

pub fn no_postinst(self) -> Self

Resets postinst script.

pub fn prerm_from_str(self, script: &str) -> Self

Sets prerm script from &str.

pub fn prerm_from_buf(self, script: Vec<u8>) -> Self

Sets prerm script from Vec.

pub fn no_prerm(self) -> Self

Resets prerm script.

pub fn postrm_from_str(self, script: &str) -> Self

Sets postrm script from &str.

pub fn postrm_from_buf(self, script: Vec<u8>) -> Self

Sets postrm script from Vec.

pub fn no_postrm(self) -> Self

Resets postrm script.

pub fn set_compression(self, compression: DebCompression) -> Self

Sets the package’s compression standard.

pub fn name(&self) -> &str

Returns the package’s name.

pub fn version(&self) -> &str

Returns the package’s version.

pub fn priority(&self) -> &DebPriority

Returns the package’s priority.

pub fn architecture(&self) -> &DebArchitecture

Returns the package’s architecture.

pub fn essential(&self) -> bool

Returns whether the package is essential.

pub fn depends(&self) -> &Vec<String>

Returns the package’s depends.

pub fn pre_depends(&self) -> &Vec<String>

Returns the package’s pre-depends.

pub fn recommends(&self) -> &Vec<String>

Returns the package’s recommends.

pub fn suggests(&self) -> &Vec<String>

Returns the package’s suggests.

pub fn breaks(&self) -> &Vec<String>

Returns the package’s breaks.

pub fn conflicts(&self) -> &Vec<String>

Returns the package’s conflicts.

pub fn provides(&self) -> &Vec<String>

Returns the package’s provides.

pub fn replaces(&self) -> &Vec<String>

Returns the package’s replaces.

pub fn enhances(&self) -> &Vec<String>

Returns the package’s enhances.

pub fn maintainer(&self) -> &str

Returns the package’s maintainer.

pub fn description(&self) -> &str

Returns the package’s description.

pub fn homepage(&self) -> &str

Returns the package’s homepage.

pub fn built_using(&self) -> &Vec<[String; 2]>

Returns the packages this package was built with.

pub fn files(&self) -> &Vec<DebFile>

Returns a vector of the packages files.

pub fn config(&self) -> Option<&Vec<u8>>

Returns the package’s config script.

pub fn preinst(&self) -> Option<&Vec<u8>>

Returns the package’s preinst script.

pub fn postinst(&self) -> Option<&Vec<u8>>

Returns the package’s postinst script.

pub fn prerm(&self) -> Option<&Vec<u8>>

Returns the package’s prerm script.

pub fn postrm(&self) -> Option<&Vec<u8>>

Returns the package’s postrm script.

pub fn compression(&self) -> &DebCompression

Returns the package’s compression standard.

pub fn build(&self) -> Result<DebArchive>

Builds the package into a DebArchive struct.

Trait Implementations

impl Debug for DebPackage

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

Formats the value using the given formatter.