Struct oci_distribution::Reference

pub struct Reference { /* fields omitted */ }

An OCI image reference

Parsing references in the following formats is supported:

• <registry>/<repository>
• <registry>/<repository>:<tag>
• <registry>/<repository>@<digest>
• <registry>/<repository>:<tag>@<digest>

Examples

Parsing a tagged image reference:

use oci_distribution::Reference;

let reference: Reference = "docker.io/library/hello-world:latest".parse().unwrap();

assert_eq!("docker.io", reference.registry());
assert_eq!("library/hello-world", reference.repository());
assert_eq!(Some("latest"), reference.tag());
assert_eq!(None, reference.digest());

Implementations

impl Reference

pub fn whole(&self) -> &str

Get the original reference.

pub fn registry(&self) -> &str

Get the registry name.

pub fn repository(&self) -> &str

Get the repository (a.k.a the image name) of this reference

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

Get the tag for this reference.

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

Get the digest for this reference.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a copy 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 Eq for Reference

impl FromStr for Reference

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Reference

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 Into<String> for Reference

fn into(self) -> String

Performs the conversion.

impl PartialEq<Reference> for Reference

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

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

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

This method tests for !=.

impl StructuralEq for Reference

impl StructuralPartialEq for Reference

impl<'_> TryFrom<&'_ str> for Reference

type Error = Error

The type returned in the event of a conversion error.

fn try_from(string: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Reference

type Error = Error

The type returned in the event of a conversion error.

fn try_from(string: String) -> Result<Self, Self::Error>

Performs the conversion.