Struct ImageRef

pub struct ImageRef {
    pub registry: Option<String>,
    pub image: String,
    pub tag: Option<String>,
    pub hash: Option<String>,
}

A parsed docker image reference

The Display impl may be used to convert a parsed image back to a plain string:

use dockerfile_parser::ImageRef;

let image = ImageRef::parse("alpine:3.11");
assert_eq!(image.registry, None);
assert_eq!(image.image, "alpine");
assert_eq!(image.tag, Some("3.11".to_string()));
assert_eq!(format!("{}", image), "alpine:3.11");

Fields

registry: Option<String>

an optional registry, generally Docker Hub if unset

image: String

an image string, possibly including a user or organization name

tag: Option<String>

An optional image tag (after the colon, e.g. :1.2.3), generally inferred to mean :latest if unset

hash: Option<String>

An optional embedded image hash, e.g. sha256:.... Conflicts with tag.

Implementations

impl ImageRef

pub fn parse(s: &str) -> ImageRef

Parses an ImageRef from a string.

This is not fallible, however malformed image strings may return unexpected results.

pub fn resolve_vars_with_context<'a>( &self, dockerfile: &'a Dockerfile, ) -> Option<(ImageRef, HashSet<String>)>

Given a Dockerfile (and its global ARGs), perform any necessary variable substitution to resolve any variable references in this ImageRef and returns a list of variables included in the end result.

If this ImageRef contains any unknown variables or if any references are excessively recursive, returns None; otherwise, returns the fully-substituted string.

pub fn resolve_vars(&self, dockerfile: &Dockerfile) -> Option<ImageRef>

Given a Dockerfile (and its global ARGs), perform any necessary variable substitution to resolve any variable references in this ImageRef.

If this ImageRef contains any unknown variables or if any references are excessively recursive, returns None; otherwise, returns the fully-substituted string.

Trait Implementations

impl Clone for ImageRef

fn clone(&self) -> ImageRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageRef

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

Formats the value using the given formatter.

impl Display for ImageRef

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

Formats the value using the given formatter.

impl PartialEq for ImageRef

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

impl StructuralPartialEq for ImageRef