Struct Api 

pub struct Api {
    pub class: String,
    pub group: String,
    pub api_version: Option<String>,
    pub exclusive: Option<bool>,
    pub condition: Option<String>,
    pub license_set: Option<String>,
    pub changelog: Option<String>,
    pub description: Option<String>,
    pub files: Option<ApiFiles>,
}

Represents a PDSC api element

Defines a software API identified by a component class, group, and optional version.

Fields

class: String

Component class identifier

group: String

Component group identifier

api_version: Option<String>

API version; part of the API ID when present

exclusive: Option<bool>

If false, multiple implementations of the API may coexist; default is true

condition: Option<String>

References a condition ID; this API applies only if the condition is met

license_set: Option<String>

References a licenseSet identifier governing usage rights

changelog: Option<String>

References a changelog ID with the API change history

description: Option<String>

Brief description of the API (max 256 characters)

files: Option<ApiFiles>

Header and documentation files that define the API interface

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl Default for Api

fn default() -> Api

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Api

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Api

impl PartialEq for Api

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Api

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 Api