Struct Purpose 

pub struct Purpose {
    role: Role,
    mode: Mode,
}

Combines a Role and a Mode to describe the context in which signature verifiers in a directory structure are used.

The combination of Role and Mode reflects one directory layer in the VOA directory hierarchy. Purpose paths have values such as: packages, trust-anchor-packages, repository-metadata.

See https://uapi-group.org/specifications/specs/file_hierarchy_for_the_verification_of_os_artifacts/#purpose

Fields

role: Role

mode: Mode

Implementations

impl Purpose

pub fn new(role: Role, mode: Mode) -> Purpose

Creates a new Purpose.

Examples

use voa_core::identifiers::{Mode, Purpose, Role};

Purpose::new(Role::Packages, Mode::ArtifactVerifier);

pub fn parser(input: &mut &str) -> Result<Purpose, ErrMode<ContextError>>

Recognizes a Purpose in a string slice.

Errors

Examples

use voa_core::identifiers::{Mode, Purpose, Role};
use winnow::Parser;

assert_eq!(
    Purpose::parser.parse("trust-anchor-test")?,
    Purpose::new(Role::Custom("test".parse()?), Mode::TrustAnchor),
);
assert_eq!(
    Purpose::parser.parse("test")?,
    Purpose::new(Role::Custom("test".parse()?), Mode::ArtifactVerifier),
);

pub fn purpose_to_string(&self) -> String

A String representation of this Purpose specifier.

This function produces the exact representation specified in https://uapi-group.org/specifications/specs/file_hierarchy_for_the_verification_of_os_artifacts/#purpose

pub fn is_trust_anchor(&self) -> bool

Checks whether self uses Mode::TrustAnchor.

Returns true if self uses Mode::TrustAnchor, false otherwise.

pub fn to_trust_anchor(self) -> Purpose

Consumes self and returns a Purpose which uses Mode::TrustAnchor.

Trait Implementations

impl Clone for Purpose

fn clone(&self) -> Purpose

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Purpose

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Purpose

fn deserialize<__D>( __deserializer: __D, ) -> Result<Purpose, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Purpose

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

Formats the value using the given formatter.

impl From<Purpose> for ConfigPurpose

fn from(value: Purpose) -> Self

Converts to this type from the input type.

impl FromStr for Purpose

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Purpose

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 Purpose

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

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

fn partial_cmp(&self, other: &Purpose) -> 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.

impl Serialize for Purpose

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Purpose

impl StructuralPartialEq for Purpose