appstream 0.2.2

Appstream files parser
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! # Appstream
//!
//! AppStream is a cross-distro effort for enhancing the metadata available about software components in the Linux and free-software ecosystem.
//! One of the project's goals is to make building software-center applications possible, and make interaction with the package sources of
//! a distribution smarter. AppStream provides specifications for meta-information which is shipped by upstream projects
//! and can be consumed by other software. The meta-information includes data which is interesting to display in software centers
//! and is mainly useful for end-users, as well as descriptions about the public interfaces a software component provides,
//!  which is mainly useful for developers, 3rd-party software installers and for automatically installing missing components
//!  on a distribution, for example missing firmware or mimetype-handlers.
//!
//! Specifications: [https://www.freedesktop.org/software/appstream/docs/](https://www.freedesktop.org/software/appstream/docs/)
//!
//! This crate aimes to provide an easy and sane Rust parser of Appstream using [xmltree](https://docs.rs/xmltree/)
//!
//! # Examples
//! ```
//! use appstream::{Component, ParseError};
//! use appstream::builders::{ComponentBuilder, ReleaseBuilder};
//! use appstream::TranslatableString;
//! use appstream::enums::{Provide, ProjectUrl};
//! use url::Url;
//! use chrono::{Utc, TimeZone};
//! use std::convert::TryFrom;
//!
//! fn main() -> Result<(), ParseError> {
//!
//!     let xml = r"<?xml version='1.0' encoding='UTF-8'?>
//!                     <component>
//!                         <id>com.example.foobar</id>
//!                         <name>Foo Bar</name>
//!                         <summary>A foo-ish bar</summary>
//!                         <url type='homepage'>http://www.example.org</url>
//!                         <metadata_license>CC0-1.0</metadata_license>
//!                         
//!                         <provides>
//!                           <library>libfoobar.so.2</library>
//!                           <font>foo.ttf</font>
//!                           <binary>foobar</binary>
//!                         </provides>
//!                         <releases>
//!                           <release version='1.2' date='2015-02-16'/>
//!                         </releases>
//!                         <developer_name>FooBar Team</developer_name>
//!                     </component>";
//!     let element = xmltree::Element::parse(xml.as_bytes())?;
//!     let c1 = Component::try_from(&element)?;
//!
//!     let c2 = ComponentBuilder::default()
//!         .id("com.example.foobar".into())
//!         .name(TranslatableString::with_default("Foo Bar"))
//!         .metadata_license("CC0-1.0".into())
//!         .summary(TranslatableString::with_default("A foo-ish bar"))
//!         .url(ProjectUrl::Homepage(
//!             Url::parse("http://www.example.org")?,
//!         ))
//!         .developer_name(TranslatableString::with_default("FooBar Team"))
//!         .provide(Provide::Library("libfoobar.so.2".into()))
//!         .provide(Provide::Font("foo.ttf".into()))
//!         .provide(Provide::Binary("foobar".into()))
//!         .release(
//!             ReleaseBuilder::new("1.2")
//!                 .date(Utc.ymd(2015, 2, 16).and_hms_milli(0, 0, 0, 0))
//!                 .build(),
//!         )
//!         .build();
//!
//!     assert_eq!(c1, c2);
//!     
//!     Ok(())
//! }
//! ```
//!
//! The library can parse a collection of components as well
//! ```no_run
//! use appstream::{Collection, Component, ParseError};
//!
//! fn main() -> Result<(), ParseError> {
//!     let collection = Collection::from_path("/var/lib/flatpak/appstream/flathub/x86_64/active/appstream.xml".into())?;
//!     #[cfg(feature="gzip")]
//!     let collection = Collection::from_gzipped("/var/lib/flatpak/appstream/flathub/x86_64/active/appstream.xml.gz".into())?;
//!     // Find a specific application by id
//!     println!("{:#?}", collection.find_by_id("org.gnome.design.Contrast".into()));
//!
//!     // Find the list of gedit plugins
//!     collection.components.iter()
//!         .filter(|c| c.extends.contains(&"org.gnome.gedit".into()))
//!         .collect::<Vec<&Component>>();
//!
//!     Ok(())
//! }
//! ```
//!
#![deny(missing_docs)]

mod app_id;
/// Various helpers to build any appstream type.
pub mod builders;
mod collection;
mod component;
mod content_rating;
/// Various enumerations used in the appstream types.
pub mod enums;
mod error;
mod language;
mod license;
mod release;
mod screenshot;
mod translatable_string;
mod xml;

pub use app_id::AppId;
pub use collection::Collection;
pub use component::Component;
pub use content_rating::ContentRating;
pub use error::ParseError;
pub use language::Language;
pub use license::License;
pub use release::{Artifact, Release};
pub use screenshot::{Image, Screenshot, Video};
pub use translatable_string::{MarkupTranslatableString, TranslatableList, TranslatableString};
pub use url;
pub use xmltree;