Struct PackageCreationConfig

pub struct PackageCreationConfig {
    package_input: PackageInput,
    output_dir: OutputDir,
    compression: Option<CompressionSettings>,
}

A config that tracks the components needed for the creation of an alpm-package from input directory.

Tracks a PackageInput, optional CompressionSettings and an OutputDir in which an alpm-package is placed after creation.

Fields

package_input: PackageInput

output_dir: OutputDir

compression: Option<CompressionSettings>

Implementations

impl PackageCreationConfig

pub fn new( package_input: PackageInput, output_dir: OutputDir, compression: Option<CompressionSettings>, ) -> Result<Self, Error>

Creates a new PackageCreationConfig.

Errors

Returns an error if

• package_input.input_dir is equal to output_dir,
• package_input.input_dir is located inside of output_dir,
• or output_dir is located inside of package_input.input_dir.

pub fn package_input(&self) -> &PackageInput

Returns a reference to the PackageInput.

pub fn output_dir(&self) -> &OutputDir

Returns a reference to the OutputDir.

pub fn compression(&self) -> Option<&CompressionSettings>

Returns a reference to the CompressionSettings.

Trait Implementations

impl Clone for PackageCreationConfig

fn clone(&self) -> PackageCreationConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageCreationConfig

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

Formats the value using the given formatter.

impl TryFrom<&PackageCreationConfig> for Package

fn try_from(value: &PackageCreationConfig) -> Result<Self, Self::Error>

Creates a new Package from a PackageCreationConfig.

Before creating a Package, guarantees the on-disk file consistency with the help of available Mtree data.

Errors

Returns an error if

• creating a PackageFileName from value fails,
• creating a CompressionEncoder fails,
• creating a compressed or uncompressed package file fails,
• validating any of the paths using ALPM-MTREE data (available through value) fails,
• appending files to a compressed or uncompressed package file fails,
• finishing a compressed or uncompressed package file fails,
• or creating a Package fails.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<&PackageCreationConfig> for PackageFileName

fn try_from(value: &PackageCreationConfig) -> Result<Self, Self::Error>

Creates a PackageFileName from a reference to a PackageCreationConfig.

Errors

Returns an error if the PackageInfo tracked by value is no longer valid or present.

type Error = Error

The type returned in the event of a conversion error.