Struct PackageFileName

pub struct PackageFileName {
    name: Name,
    version: Version,
    architecture: Architecture,
    compression: Option<CompressionAlgorithmFileExtension>,
}

The full filename of a package.

A package filename tracks its Name, Version, Architecture and the optional CompressionAlgorithmFileExtension.

Fields

name: Name

version: Version

architecture: Architecture

compression: Option<CompressionAlgorithmFileExtension>

Implementations

impl PackageFileName

pub fn new( name: Name, version: Version, architecture: Architecture, compression: Option<CompressionAlgorithmFileExtension>, ) -> Result<Self, Error>

Creates a new PackageFileName.

Errors

Returns an error if the provided version does not have the pkgrel component.

Examples

use std::str::FromStr;

use alpm_types::PackageFileName;

assert_eq!(
    "example-1:1.0.0-1-x86_64.pkg.tar.zst",
    PackageFileName::new(
        "example".parse()?,
        "1:1.0.0-1".parse()?,
        "x86_64".parse()?,
        Some("zst".parse()?)
    )?
    .to_string()
);

// This fails because the provided Version does not have the pkgrel component.
assert!(
    PackageFileName::new(
        "example".parse()?,
        "1:1.0.0".parse()?,
        "x86_64".parse()?,
        Some("zst".parse()?)
    )
    .is_err()
);

pub fn name(&self) -> &Name

Returns a reference to the Name.

Examples

use std::str::FromStr;

use alpm_types::{Name, PackageFileName};

let file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;

assert_eq!(file_name.name(), &Name::new("example")?);

pub fn version(&self) -> &Version

Returns a reference to the Version.

Examples

use std::str::FromStr;

use alpm_types::{PackageFileName, Version};

let file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;

assert_eq!(file_name.version(), &Version::from_str("1:1.0.0-1")?);

pub fn architecture(&self) -> Architecture

Returns the Architecture.

Examples

use std::str::FromStr;

use alpm_types::{Architecture, PackageFileName};

let file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;

assert_eq!(file_name.architecture(), Architecture::X86_64);

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

Returns the optional CompressionAlgorithmFileExtension.

Examples

use std::str::FromStr;

use alpm_types::{CompressionAlgorithmFileExtension, PackageFileName};

let file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;

assert_eq!(
    file_name.compression(),
    Some(CompressionAlgorithmFileExtension::Zstd)
);

pub fn to_path_buf(&self) -> PathBuf

Returns the PackageFileName as PathBuf.

Examples

use std::{path::PathBuf, str::FromStr};

use alpm_types::PackageFileName;

let file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;

assert_eq!(
    file_name.to_path_buf(),
    PathBuf::from("example-1:1.0.0-1-x86_64.pkg.tar.zst")
);

pub fn set_compression( &mut self, compression: Option<CompressionAlgorithmFileExtension>, )

Sets the compression of the PackageFileName.

Examples

use std::str::FromStr;

use alpm_types::{CompressionAlgorithmFileExtension, PackageFileName};

// Create package file name with compression
let mut file_name = PackageFileName::new(
    "example".parse()?,
    "1:1.0.0-1".parse()?,
    "x86_64".parse()?,
    Some("zst".parse()?),
)?;
// Remove the compression
file_name.set_compression(None);

assert!(file_name.compression().is_none());

// Add other compression
file_name.set_compression(Some(CompressionAlgorithmFileExtension::Gzip));

assert!(
    file_name
        .compression()
        .is_some_and(|compression| compression == CompressionAlgorithmFileExtension::Gzip)
);

pub fn parser(input: &mut &str) -> ModalResult<Self>

Recognizes a PackageFileName in a string slice.

Relies on [winnow] to parse input and recognize the Name, Version, Architecture and CompressionAlgorithmFileExtension components.

Errors

Returns an error if

• the Name component can not be recognized,
• the Version component can not be recognized,
• the Architecture component can not be recognized,
• or the CompressionAlgorithmFileExtension component can not be recognized.

Examples

use alpm_types::PackageFileName;
use winnow::Parser;

let filename = "example-package-1:1.0.0-1-x86_64.pkg.tar.zst";
assert_eq!(
    filename,
    PackageFileName::parser.parse(filename)?.to_string()
);

Trait Implementations

impl Clone for PackageFileName

fn clone(&self) -> PackageFileName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageFileName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageFileName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PackageFileName

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

Formats the value using the given formatter.

impl From<PackageFileName> for String

fn from(value: PackageFileName) -> Self

Creates a String from a PackageFileName.

impl FromStr for PackageFileName

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates a PackageFileName from a string slice.

Delegates to PackageFileName::parser.

Errors

Returns an error if PackageFileName::parser fails.

Examples

use std::str::FromStr;

use alpm_types::PackageFileName;

let filename = "example-package-1:1.0.0-1-x86_64.pkg.tar.zst";
assert_eq!(filename, PackageFileName::from_str(filename)?.to_string());

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for PackageFileName

fn eq(&self, other: &PackageFileName) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PackageFileName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Path> for PackageFileName

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

Creates a PackageFileName from a Path reference.

The file name in value is extracted and, if valid is turned into a string slice. The creation of the PackageFileName is delegated to PackageFileName::parser.

Errors

Returns an error if

• value does not contain a valid file name,
• value can not be turned into a string slice,
• or PackageFileName::parser fails.

Examples

use std::path::PathBuf;

use alpm_types::PackageFileName;

let filename = PathBuf::from("../example-package-1:1.0.0-1-x86_64.pkg.tar.zst");
assert_eq!(
    filename,
    PathBuf::from("..").join(PackageFileName::try_from(filename.as_path())?.to_path_buf()),
);

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<String> for PackageFileName

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

Creates a PackageFileName from a String.

Delegates to PackageFileName::parser.

Errors

Returns an error if PackageFileName::parser fails.

Examples

use std::str::FromStr;

use alpm_types::PackageFileName;

let filename = "example-package-1:1.0.0-1-x86_64.pkg.tar.zst".to_string();
assert_eq!(
    filename.clone(),
    PackageFileName::try_from(filename)?.to_string()
);

type Error = Error

The type returned in the event of a conversion error.

impl Eq for PackageFileName

impl StructuralPartialEq for PackageFileName