Struct About 

#[non_exhaustive]
pub struct About {
    pub pkg_name: Txt,
    pub pkg_authors: Box<[Txt]>,
    pub version: Version,
    pub app_id: Txt,
    pub app: Txt,
    pub org: Txt,
    pub description: Txt,
    pub homepage: Txt,
    pub license: Txt,
    pub has_about: bool,
    pub meta: Vec<(Txt, Txt)>,
    pub is_test: bool,
}

Metadata about the app and main crate.

See about for more details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pkg_name: Txt

package.name

Cargo crate name for the entry crate.

pkg_authors: Box<[Txt]>

package.authors

Cargo crate authors for the entry crate.

version: Version

package.version

Cargo crate version for the entry crate.

app_id: Txt

package.metadata.zng.about.app_id

Fully qualified unique name for the application. Is a list of one or more dot-separated identifiers, each identifier starts with letter, identifiers contains only letters, digits and underscore. A reverse DNS name is recommended.

If the metadata is not set an id is derived from "qualifier", org and app values.

app: Txt

package.metadata.zng.about.app

App display name.

If the metadata is not set the pkg_name is used.

org: Txt

package.metadata.zng.about.org

Organization display name.

If the metadata is not set the first pkg_authors is used.

description: Txt

package.description

Short description of the app.

homepage: Txt

package.homepage

Valid website about the app.

license: Txt

package.license

License title of the app.

has_about: bool

If package.metadata.zng.about is set on the Cargo.toml manifest.

The presence of this section is used by cargo zng res to find the main crate if the workspace has multiple bin crates.

meta: Vec<(Txt, Txt)>

package.metadata.zng.about.*

Any other unknown string metadata.

is_test: bool

If app was started in a cfg(test) build binary.

Implementations

impl About

pub fn crate_name(&self) -> Txt

The pkg_name in snake_case.

pub fn qualifier(&self) -> Txt

The first components of app_id except the last two.

For app id "br.com.company.product" the qualifier is "br.com". For id "company.product" the qualifier is empty.

pub fn get(&self, key: &str) -> Option<Txt>

Get the value.

The key can be an entry of meta, the name of a field or the name of a value method.

pub fn windows_aumid(&self) -> Txt

Get the Windows AppUserModelID.

This ID identifies the app for shell integration, like notifications. A shortcut on the Start Menu must define a System.AppUserModel.ID that matches this ID.

By default this is the app_id, its strongly recommended that the app only use one ID, but if required the AUMID can be explicitly set on the metadata using the "windows_aumid".

On startup the default view-process calls SetCurrentProcessExplicitAppUserModelID to ensure the GUI is associated with the Start Menu entry even when not running from the start menu.

impl About

pub fn parse_manifest(cargo_toml: &str) -> Result<Self, Error>

Parse a Cargo.toml string.

Trait Implementations

impl Clone for About

fn clone(&self) -> About

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for About

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for About

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for About

impl Hash for About

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for About

fn eq(&self, other: &About) -> 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 About

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for About