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) -> Self

Creates a new Purpose.

Examples

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

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

pub fn parser(input: &mut &str) -> ModalResult<Self>

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),
);

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(crate) fn path_segment(&self) -> PathBuf

Returns the path segment for this Purpose

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

Formats the value using the given formatter.

impl Display for Purpose

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

Formats the value using the given formatter.

impl FromStr for Purpose

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

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 Serialize for Purpose

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 Purpose