# alpm-types
Types for **A**rch **L**inux **P**ackage **M**anagement.
The provided types and the traits they implement can be used in package
management related applications (e.g. package manager, repository manager,
special purpose parsers and file specifications, etc.) which deal with
[libalpm](https://man.archlinux.org/man/libalpm.3) based packages.
This library strives to provide all underlying types for writing ALPM based
software as a leaf-crate, so that they can be shared across applications and
none of them has to implement them itself.
## Examples
Known CPU architectures are represented by the `Architecture` enum.
You can create members e.g. from str:
```rust
use std::str::FromStr;
use alpm_types::Architecture;
assert_eq!(Architecture::from_str("aarch64"), Ok(Architecture::Aarch64));
```
The date when a package has been built is represented using the `BuildDate`
struct, which tracks this in seconds since the epoch.
Apart from creating BuildDate from i64 or str, it can also be created from
`DateTime<Utc>`:
```rust
use chrono::{DateTime, NaiveDateTime, Utc};
use alpm_types::BuildDate;
let datetime: BuildDate = DateTime::<Utc>::from_utc(NaiveDateTime::from_timestamp_opt(1, 0).unwrap(), Utc).into();
assert_eq!(BuildDate::new(1), datetime);
```
The compressed size of a package is represented by `CompressedSize` which
tracks the size in bytes and can also be created from str:
```rust
use alpm_types::CompressedSize;
use std::str::FromStr;
assert_eq!(CompressedSize::from_str("1"), Ok(CompressedSize::new(1)));
```
The installed size of a package is represented by `InstalledSize` which
tracks the size in bytes and can also be created from str:
```rust
use alpm_types::InstalledSize;
use std::str::FromStr;
assert_eq!(InstalledSize::from_str("1"), Ok(InstalledSize::new(1)));
```
The name for a package is restricted to a specific set of characters.
You can create `Name` directly or from str, which yields a Result:
```rust
use std::str::FromStr;
use alpm_types::{Error, Name};
assert_eq!(Name::from_str("test-123@.foo_+"), Ok(Name::new("test-123@.foo_+")));
assert_eq!(Name::from_str(".foo"), Err(Error::InvalidName(".foo".to_string())));
```
Package types are distinguished using the `PkgType` enum. Its variants can be constructed from str:
```rust
use std::str::FromStr;
use alpm_types::PkgType;
assert_eq!(PkgType::from_str("pkg"), Ok(PkgType::Package));
```
## Contributing
Please refer to the [contribution guidelines](CONTRIBUTING.md) to learn how to
contribute to this project.
## License
This project is licensed under the terms of the
[LGPL-3.0-or-later](https://www.gnu.org/licenses/lgpl-3.0.en.html).