Struct ocipkg::image::annotations::flat::Annotations

pub struct Annotations {

    pub created: Option<String>,
    pub authors: Option<String>,
    pub url: Option<String>,
    pub documentation: Option<String>,
    pub source: Option<String>,
    pub version: Option<String>,
    pub revision: Option<String>,
    pub vendor: Option<String>,
    pub licenses: Option<String>,
    pub ref_name: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub base_digest: Option<String>,
    pub base_name: Option<String>,
}

org.opencontainers.image.* annotations

See Pre-Defined Annotation Keys in OCI image spec.

This is designed to use with JSON

use ocipkg::image::annotations::flat::*;

let a = Annotations::from_json(r#"
{
  "org.opencontainers.image.url": "https://github.com/termoshtt/ocipkg"
}
"#).unwrap();
assert_eq!(
    a,
    Annotations {
        url: Some("https://github.com/termoshtt/ocipkg".to_string()),
        ..Default::default()
    }
);

// Dump to JSON
let a = Annotations {
    url: Some("https://github.com/termoshtt/ocipkg".to_string()),
    ..Default::default()
};
assert_eq!(a.to_json().trim(), r#"
{
  "org.opencontainers.image.url": "https://github.com/termoshtt/ocipkg"
}
"#.trim());

Fields

created: Option<String>

org.opencontainers.image.created

date and time on which the image was built (string, date-time as defined by RFC 3339).

authors: Option<String>

org.opencontainers.image.authors

contact details of the people or organization responsible for the image (freeform string)

url: Option<String>

org.opencontainers.image.url

URL to find more information on the image (string)

documentation: Option<String>

org.opencontainers.image.documentation

URL to get documentation on the image (string)

source: Option<String>

org.opencontainers.image.source

URL to get source code for building the image (string)

version: Option<String>

org.opencontainers.image.version

version of the packaged software

revision: Option<String>

org.opencontainers.image.revision

Source control revision identifier for the packaged software.

vendor: Option<String>

org.opencontainers.image.vendor

Name of the distributing entity, organization or individual.

licenses: Option<String>

org.opencontainers.image.licenses

License(s) under which contained software is distributed as an SPDX License Expression.

ref_name: Option<String>

org.opencontainers.image.ref.name

Name of the reference for a target (string).

title: Option<String>

org.opencontainers.image.title

Human-readable title of the image (string)

description: Option<String>

org.opencontainers.image.description

Human-readable description of the software packaged in the image (string)

base_digest: Option<String>

org.opencontainers.image.base.digest

Digest of the image this image is based on (string)

base_name: Option<String>

org.opencontainers.image.base.name

Annotations reference of the image this image is based on (string)

Implementations

impl Annotations

pub fn from_map(annotations: HashMap<String, String>) -> Result<Self>

pub fn from_json(input: &str) -> Result<Self>

pub fn to_map(&self) -> HashMap<String, String>

pub fn to_json(&self) -> String

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Annotations

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

Deserialize this value from the given Serde deserializer.

impl From<Annotations> for Annotations

fn from(nested: Annotations) -> Self

Converts to this type from the input type.

impl From<Annotations> for Annotations

fn from(flat: Annotations) -> Self

Converts to this type from the input type.

impl FromIterator<(String, String)> for Annotations

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = (String, String)>, 

Creates a value from an iterator.

impl Hash for Annotations

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Annotations> for Annotations

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

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

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

This method tests for !=.

impl Serialize for Annotations

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Annotations

impl StructuralEq for Annotations

impl StructuralPartialEq for Annotations