Struct Os 

pub struct Os {
    id: IdentifierString,
    version_id: Option<IdentifierString>,
    variant_id: Option<IdentifierString>,
    image_id: Option<IdentifierString>,
    image_version: Option<IdentifierString>,
}

The Os identifier is used to uniquely identify an Operating System (OS), it relies on data provided by os-release.

Format

An Os identifier consists of up to five parts. Each part of the identifier can consist of the characters “0–9”, “a–z”, “.”, “_” and “-”.

In the filesystem, the parts are concatenated into one path using : (colon) symbols (e.g. debian:12:server:company-x:25.01).

Trailing colons must be omitted for all parts that are unset (e.g. arch instead of arch::::).

However, colons for intermediate parts must be included. (e.g. debian:12:::25.01).

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

Fields

id: IdentifierString

version_id: Option<IdentifierString>

variant_id: Option<IdentifierString>

image_id: Option<IdentifierString>

image_version: Option<IdentifierString>

Implementations

impl Os

pub fn new( id: IdentifierString, version_id: Option<IdentifierString>, variant_id: Option<IdentifierString>, image_id: Option<IdentifierString>, image_version: Option<IdentifierString>, ) -> Os

Creates a new operating system identifier.

Examples

use voa_core::identifiers::Os;

// Arch Linux is a rolling release distribution.
Os::new("arch".parse()?, None, None, None, None);

// This Debian system is a special purpose image-based OS.
Os::new(
    "debian".parse()?,
    Some("12".parse()?),
    Some("workstation".parse()?),
    Some("cashier-system".parse()?),
    Some("1.0.0".parse()?),
);

pub fn os_to_string(&self) -> String

A String representation of this Os specifier.

All parts are joined with :, trailing colons are omitted. Parts that are unset are represented as empty strings.

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

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

Recognizes an Os in a string slice.

Relies on [winnow] to parse input and recognizes the id, and the optional version_id, variant_id, image_id and image_version components.

Errors

Returns an error, if

• detection of one of the Os components fails,
• or there is a trailing colon (:) character.

Examples

use voa_core::identifiers::Os;
use winnow::Parser;

Os::parser.parse("arch")?;
Os::parser.parse("debian:13:test-system:test-image:2025.01")?;

Trait Implementations

impl Clone for Os

fn clone(&self) -> Os

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Os

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Os

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Os

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

Formats the value using the given formatter.

impl From<Os> for ConfigOs

fn from(value: Os) -> Self

Converts to this type from the input type.

impl FromStr for Os

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

Creates an Os from a string slice.

Note

Delegates to Os::parser.

Errors

Returns an error if Os::parser fails.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Os

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 Os

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

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

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

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 TryFrom<&OsStr> for Os

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &OsStr) -> Result<Os, <Os as TryFrom<&OsStr>>::Error>

Performs the conversion.

impl Eq for Os

impl StructuralPartialEq for Os