Struct Annotation 

pub struct Annotation { /* private fields */ }

An OCI annotation key/value pair.

Implementations

impl Annotation

pub fn new( key: impl AsRef<str>, value: impl AsRef<str>, ) -> Result<Annotation, AnnotationError>

Creates an annotation.

pub fn title(value: impl AsRef<str>) -> Result<Annotation, AnnotationError>

Creates an OCI title annotation.

Examples found in repository

examples/basic_usage.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let parsed_digest: digest::OciDigest =
        "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;
    let descriptor = descriptor::OciDescriptor::new(
        media_type::OciMediaType::image_manifest(),
        parsed_digest,
        descriptor::DescriptorSize::new(7023),
    );
    let linux_arm64 =
        platform::OciPlatform::new(platform::OciOs::Linux, platform::OciArchitecture::Arm64);
    let title = annotation::Annotation::title("RustUse OCI example")?;
    let image_ref: reference::ImageReference =
        "ghcr.io/rustuse/app:0.1.0@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;

    assert_eq!(descriptor.size().as_u64(), 7023);
    assert_eq!(linux_arm64.to_string(), "linux/arm64");
    assert_eq!(title.value().as_str(), "RustUse OCI example");
    assert_eq!(image_ref.repository().as_str(), "rustuse/app");
    Ok(())
}

pub fn description( value: impl AsRef<str>, ) -> Result<Annotation, AnnotationError>

Creates an OCI description annotation.

pub fn source(value: impl AsRef<str>) -> Result<Annotation, AnnotationError>

Creates an OCI source annotation.

pub const fn key(&self) -> &AnnotationKey

Returns the key.

pub const fn value(&self) -> &AnnotationValue

Returns the value.

Examples found in repository

examples/basic_usage.rs (line 19)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let parsed_digest: digest::OciDigest =
        "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;
    let descriptor = descriptor::OciDescriptor::new(
        media_type::OciMediaType::image_manifest(),
        parsed_digest,
        descriptor::DescriptorSize::new(7023),
    );
    let linux_arm64 =
        platform::OciPlatform::new(platform::OciOs::Linux, platform::OciArchitecture::Arm64);
    let title = annotation::Annotation::title("RustUse OCI example")?;
    let image_ref: reference::ImageReference =
        "ghcr.io/rustuse/app:0.1.0@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;

    assert_eq!(descriptor.size().as_u64(), 7023);
    assert_eq!(linux_arm64.to_string(), "linux/arm64");
    assert_eq!(title.value().as_str(), "RustUse OCI example");
    assert_eq!(image_ref.repository().as_str(), "rustuse/app");
    Ok(())
}

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Display for Annotation

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

Formats the value using the given formatter.

impl Hash for Annotation

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 Annotation

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

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

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

impl StructuralPartialEq for Annotation