Struct cpe::wfn::Wfn

pub struct Wfn<'a> { /* fields omitted */ }

A CPE 2.3 Well-Formed Name

Note: field access is limited to ensure values only contain semantically valid components. Fields can be accessed through the "getter" methods, or through the Cpe methods, although the former is preferred with a Cpe as opposed to an OwnedCpe.

Display is implemented to show the decoded contents by default, or to re-encode the components when # is used to specify an alternate.

 use cpe::wfn::Wfn;
 let wfn = Wfn::builder()
           .part("a")
           .vendor("foo\\!")
           .validate()
           .unwrap();

 assert_eq!(format!("{}", wfn), "wfn:[part=a,vendor=foo!,product=ANY,version=ANY,update=ANY,edition=ANY,language=ANY,sw_edition=ANY,target_sw=ANY,target_hw=ANY,other=ANY]".to_owned());
 assert_eq!(format!("{:#}", wfn), "wfn:[part=a,vendor=foo\\!,product=ANY,version=ANY,update=ANY,edition=ANY,language=ANY,sw_edition=ANY,target_sw=ANY,target_hw=ANY,other=ANY]".to_owned());

Additionally, the 0 for zero-padding integers can be used to omit default "ANY" fields.

 use cpe::wfn::Wfn;
 let wfn = Wfn::builder()
           .part("a")
           .vendor("foo\\!")
           .validate()
           .unwrap();

 assert_eq!(format!("{:0}", wfn), "wfn:[part=a,vendor=foo!]".to_owned());
 assert_eq!(format!("{:#0}", wfn), "wfn:[part=a,vendor=foo\\!]".to_owned());

Implementations

impl<'a> Wfn<'a>

pub fn new() -> Self

Create a default Wfn with all fields set to ANY.

pub fn builder() -> CpeBuilder<'a, Wfn<'a>>

Create a CpeBuilder struct to construct a new Wfn.

use cpe::wfn::Wfn;

let cpe: Wfn = Wfn::builder()
              .part("a")
              .vendor("rust")
              .product("cargo")
              .validate()
              .unwrap();

println!("{:?}", cpe);

pub fn set_part(&mut self, part: &'a str) -> Result<()>

Set the CPE type part, a, o, h, or *.

The provided string slice will be parsed to its semantic meaning.

pub fn set_vendor(&mut self, vendor: &'a str) -> Result<()>

Set the CPE vendor.

The provided string slice will be parsed to its semantic meaning.

pub fn set_product(&mut self, product: &'a str) -> Result<()>

Set the CPE product.

The provided string slice will be parsed to its semantic meaning.

pub fn set_version(&mut self, version: &'a str) -> Result<()>

Set the CPE product.

The provided string will be parsed to its semantic meaning.

pub fn set_update(&mut self, update: &'a str) -> Result<()>

Set the CPE update.

The provided string will be parsed to its semantic meaning.

pub fn set_edition(&mut self, edition: &'a str) -> Result<()>

Set the CPE edition.

The provided string will be parsed to its semantic meaning. Note that this funciton will not unpack a packed ~ delimited edition component.

pub fn set_language(&mut self, language: &'a str) -> Result<()>

Set the CPE language.

The provided string will be parsed to its semantic meaning. language must be a valid RFC-5646 language tag.

pub fn set_sw_edition(&mut self, sw_edition: &'a str) -> Result<()>

Set the CPE software edition.

The provided string will be parsed to its semantic meaning.

pub fn set_target_sw(&mut self, target_sw: &'a str) -> Result<()>

Set the CPE target software.

The provided string will be parsed to its semantic meaning.

pub fn set_target_hw(&mut self, target_hw: &'a str) -> Result<()>

Set the CPE target hardware.

The provided string will be parsed to its semantic meaning.

pub fn set_other(&mut self, other: &'a str) -> Result<()>

Set the CPE "other" value.

The provided string will be parsed to its semantic meaning.

pub fn to_owned(&self) -> OwnedWfn

Create an Owned copy of this CPE WFN.

pub fn as_uri(&self) -> Uri<'a>

Create a Uri, perserving lifetimes of the original input. Note that strings may be cloned if the input was decoded.

pub fn parse(value: &'a str) -> Result<Self>

Parse a CPE URI string.

This function will decode percent encodings and special characters to their semantic meaning.

Trait Implementations

impl<'_> Cpe for Wfn<'_>

fn part(&self) -> CpeType

fn vendor(&self) -> Component<'_>

fn product(&self) -> Component<'_>

fn version(&self) -> Component<'_>

fn update(&self) -> Component<'_>

fn edition(&self) -> Component<'_>

fn language(&self) -> &Language

fn sw_edition(&self) -> Component<'_>

fn target_sw(&self) -> Component<'_>

fn target_hw(&self) -> Component<'_>

fn other(&self) -> Component<'_>

impl<'a> Debug for Wfn<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Wfn<'a>

fn default() -> Wfn<'a>

Returns the "default value" for a type.

impl<'_> Display for Wfn<'_>

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

Formats the value using the given formatter.

impl<'a, '_> From<&'_ Uri<'a>> for Wfn<'a>

fn from(uri: &Uri<'a>) -> Self

Performs the conversion.

impl<'_, '_> From<&'_ Wfn<'_>> for OwnedUri

fn from(cpe: &Wfn<'_>) -> Self

Performs the conversion.

impl<'_, '_> From<&'_ Wfn<'_>> for OwnedWfn

fn from(cpe: &Wfn<'_>) -> Self

Performs the conversion.

impl<'a, '_> From<&'_ Wfn<'a>> for Uri<'a>

fn from(wfn: &Wfn<'a>) -> Self

Performs the conversion.

impl<'a> From<Uri<'a>> for Wfn<'a>

fn from(uri: Uri<'a>) -> Self

Performs the conversion.

impl<'_> From<Wfn<'_>> for OwnedUri

fn from(cpe: Wfn<'_>) -> Self

Performs the conversion.

impl<'_> From<Wfn<'_>> for OwnedWfn

fn from(cpe: Wfn<'_>) -> Self

Performs the conversion.

impl<'a> From<Wfn<'a>> for Uri<'a>

fn from(wfn: Wfn<'a>) -> Self

Performs the conversion.

impl<'a> PartialEq<Wfn<'a>> for Wfn<'a>

fn eq(&self, other: &Wfn<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Wfn<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Wfn<'a>