Struct ocipkg::ImageName

pub struct ImageName {
    pub hostname: String,
    pub port: Option<u16>,
    pub name: Name,
    pub reference: Reference,
}

Image name

The input must be valid both as “org.opencontainers.image.ref.name” defined in pre-defined annotation keys in OCI image spec:

ref       ::= component ("/" component)*
component ::= alphanum (separator alphanum)*
alphanum  ::= [A-Za-z0-9]+
separator ::= [-._:@+] | "--"

and as an argument for docker tag.

Terminology

We call each components of image name to match OCI distribution spec:

ghcr.io/termoshtt/ocipkg/testing:latest
^^^^^^^---------------------------------- hostname
        ^^^^^^^^^^^^^^^^^^^^^^^^--------- name
                                 ^^^^^^-- reference

use ocipkg::{ImageName, distribution::{Name, Reference}};
let name = ImageName::parse("ghcr.io/termoshtt/ocipkg/testing:latest")?;
assert_eq!(
    name,
    ImageName {
        hostname: "ghcr.io".to_string(),
        port: None,
        name: Name::new("termoshtt/ocipkg/testing")?,
        reference: Reference::new("latest")?,
    }
);

If a port number is included:

localhost:5000/test_repo:tag1
^^^^^^^^^---------------------- hostname
          ^^^^----------------- port
               ^^^^^^^^^------- name
                         ^^^^-- reference

use ocipkg::{ImageName, distribution::{Name, Reference}};
let name = ImageName::parse("localhost:5000/test_repo:latest")?;
assert_eq!(
    name,
    ImageName {
        hostname: "localhost".to_string(),
        port: Some(5000),
        name: Name::new("test_repo")?,
        reference: Reference::new("latest")?,
    }
);

Default values

If hostname is absent, use registry-1.docker.io for docker compatiblity:

use ocipkg::{ImageName, distribution::{Name, Reference}};
let name = ImageName::parse("ubuntu:20.04")?;
assert_eq!(
    name,
    ImageName {
        hostname: "registry-1.docker.io".to_string(),
        port: None,
        name: Name::new("ubuntu")?,
        reference: Reference::new("20.04")?,
    }
);

If reference is absent, use latest:

use ocipkg::{ImageName, distribution::{Name, Reference}};
let name = ImageName::parse("alpine").unwrap();
assert_eq!(
    name,
    ImageName {
        hostname: "registry-1.docker.io".to_string(),
        port: None,
        name: Name::new("alpine")?,
        reference: Reference::new("latest")?,
    }
);

Fields

hostname: String

port: Option<u16>

name: Name

reference: Reference

Implementations

impl ImageName

pub fn parse(name: &str) -> Result<Self>

pub fn registry_url(&self) -> Result<Url>

URL for OCI distribution API endpoint

Trait Implementations

impl Clone for ImageName

fn clone(&self) -> ImageName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageName

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

Formats the value using the given formatter.

impl Default for ImageName

fn default() -> Self

Returns the “default value” for a type.

impl Display for ImageName

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

Formats the value using the given formatter.

impl Hash for ImageName

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ImageName

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

impl StructuralPartialEq for ImageName