Struct PackageFamilyName 

pub struct PackageFamilyName { /* private fields */ }

A Package Family Name is an opaque string derived from only two parts of a package identity - name and publisher.

<Name>_<PublisherId>

For example, the Package Family Name of the Windows Photos app is Microsoft.Windows.Photos_8wekyb3d8bbwe, where Microsoft.Windows.Photos is the name and 8wekyb3d8bbwe is the publisher ID for Microsoft.

Package Family Name is often referred to as a ‘version-less Package Full Name’.

Implementations

impl PackageFamilyName

pub fn new(package_name: &str, publisher: &str) -> PackageFamilyName

Creates a new Package Family Name from a package name and an identity publisher.

This is equivalent to the Windows function PackageNameAndPublisherIdFromFamilyName.

Examples

let package_family_name = PackageFamilyName::new(
    "Microsoft.PowerShell",
    "CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US"
);

assert_eq!(package_family_name.to_string(), "Microsoft.PowerShell_8wekyb3d8bbwe");

pub fn package_name(&self) -> &str

Returns the package name as a string slice.

Examples

let package_family_name = PackageFamilyName::new(
    "Microsoft.PowerShell",
    "CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US"
);

assert_eq!(package_family_name.package_name(), "Microsoft.PowerShell");

pub const fn publisher_id(&self) -> &PublisherId

Returns a reference to the Publisher Id.

Examples

let package_family_name = PackageFamilyName::new(
    "Microsoft.PowerShell",
    "CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US"
);

assert_eq!(package_family_name.publisher_id().as_str(), "8wekyb3d8bbwe");

Trait Implementations

impl Clone for PackageFamilyName

fn clone(&self) -> PackageFamilyName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageFamilyName

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

Formats the value using the given formatter.

impl Default for PackageFamilyName

fn default() -> PackageFamilyName

Returns the “default value” for a type.

impl Display for PackageFamilyName

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

Formats the value using the given formatter.

impl Eq for PackageFamilyName

impl FromStr for PackageFamilyName

type Err = PackageFamilyNameError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<PackageFamilyName, <PackageFamilyName as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PackageFamilyName

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

where H: Hasher,

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 Ord for PackageFamilyName

fn cmp(&self, other: &PackageFamilyName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PackageFamilyName

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

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

Package Family Name is compared case-insensitively.

Examples

let pfn_1 = PackageFamilyName::new("PowerShell", "CN=, O=, L=, S=, C=");
let pfn_2 = PackageFamilyName::new("powershell", "CN=, O=, L=, S=, C=");

assert_eq!(pfn_1, pfn_2);

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

Inequality operator !=.

impl PartialOrd for PackageFamilyName

fn partial_cmp(&self, other: &PackageFamilyName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.