Struct Reference 

pub struct Reference {
    pub repository: Repository,
    pub tag: Option<String>,
    pub digest: Option<String>,
}

A reference is a named reference to an image

Examples:

• docker.io/library/alpine
• docker.io/library/alpine:latest
• docker.io/library/alpine@sha256:86e0e091d0da6bde2456dbb48306f3956bbeb2eae1b5b9a43045843f69fe4aaa

Fields

repository: Repository

The repository of the reference, (e.g. docker.io/library/alpine)

tag: Option<String>

The tag of the reference, (e.g. latest)

digest: Option<String>

The digest of the reference, (e.g. sha256:86e0e091d0da6bde2456dbb48306f3956bbeb2eae1b5b9a43045843f69fe4aaa)

Implementations

impl Reference

pub fn parse(s: impl AsRef<str>) -> Result<Self, Error>

Parse parses s and returns a syntactically valid Reference

pub fn parse_normalized_named(s: &str) -> Result<Self, Error>

Parses a string into a named reference transforming a familiar name from Docker UI to a fully qualified reference

pub fn domain(&self) -> &str

Returns the domain of the reference, or the default domain (docker.io) if it is not set

pub fn path(&self) -> Option<Cow<'_, str>>

Returns the path of the reference, normalized if it is an official repository

pub fn tag(&self) -> Option<&str>

The tag of the reference, or None if it is not set

pub fn digest(&self) -> Option<&str>

The digest of the reference, or None if it is not set

pub fn rank_ord(&self, other: &Self) -> Ordering

rank_ord returns a Ordering based on the following rules preferring higher information references, then by the lexicographical ordering of the reference string:

Rule	Example
[Named] + [Tagged] + [Digested]	docker.io/library/busybox:latest@sha256:<digest>
[Named] + [Tagged]	docker.io/library/busybox:latest
[Named] + [Digested]	docker.io/library/busybo@sha256:<digest>
[Named]	docker.io/library/busybox
[Digested]	docker.io@sha256:<digest>
Error	The reference is not valid due to not matching any of the above rules

Original

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Display for Reference

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

Formats the value using the given formatter.

impl PartialEq for Reference

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

impl StructuralPartialEq for Reference