Struct serde_cyclonedx::cyclonedx::v_1_4::ReleaseNotes

pub struct ReleaseNotes {
    pub aliases: Option<Vec<String>>,
    pub description: Option<String>,
    pub featured_image: Option<String>,
    pub notes: Option<Vec<Note>>,
    pub properties: Option<Vec<Property>>,
    pub resolves: Option<Vec<Issue>>,
    pub social_image: Option<String>,
    pub tags: Option<Vec<String>>,
    pub timestamp: Option<String>,
    pub title: Option<String>,
    pub type_: ReleaseType,
}

Fields

aliases: Option<Vec<String>>

One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).

description: Option<String>

A short description of the release.

featured_image: Option<String>

The URL to an image that may be prominently displayed with the release note.

notes: Option<Vec<Note>>

Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages.

properties: Option<Vec<Property>>

Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is OPTIONAL.

resolves: Option<Vec<Issue>>

A collection of issues that have been resolved.

social_image: Option<String>

The URL to an image that may be used in messaging on social media platforms.

tags: Option<Vec<String>>

One or more tags that may aid in search or retrieval of the release note.

timestamp: Option<String>

The date and time (timestamp) when the release note was created.

title: Option<String>

The title of the release.

type_: ReleaseType

The software versioning type the release note describes.

Trait Implementations

impl Clone for ReleaseNotes

fn clone(&self) -> ReleaseNotes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseNotes

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReleaseNotes

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ReleaseNotes> for ReleaseNotes

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReleaseNotes

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 ReleaseNotes