Struct Reference 

pub struct Reference { /* private fields */ }

Reference provides a general type to represent any way of referencing images within an OCI registry.

Examples

Parsing a tagged image reference:

use oci_spec::distribution::Reference;

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

assert_eq!("docker.io/library/hello-world:latest", reference.whole().as_str());
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 with_tag(registry: String, repository: String, tag: String) -> Self

Create a Reference with a registry, repository and tag.

pub fn with_digest(registry: String, repository: String, digest: String) -> Self

Create a Reference with a registry, repository and digest.

pub fn with_tag_and_digest( registry: String, repository: String, tag: String, digest: String, ) -> Self

Create a new instance of Reference with a registry, repository, tag and digest.

This is useful when you need to reference an image by both its semantic version (tag) and its content-addressable digest for immutability.

Examples

use oci_spec::distribution::Reference;

let reference = Reference::with_tag_and_digest(
    "docker.io".to_string(),
    "library/nginx".to_string(),
    "1.21".to_string(),
    "sha256:abc123...".to_string(),
);

pub fn clone_with_digest(&self, digest: String) -> Self

Clone the Reference for the same image with a new digest.

pub fn resolve_registry(&self) -> &str

Resolve the registry address of a given Reference.

Some registries, such as docker.io, uses a different address for the actual registry. This function implements such redirection.

If a mirror registry is set, it will be used instead of the original registry.

pub fn registry(&self) -> &str

Returns the name of the registry.

pub fn repository(&self) -> &str

Returns the name of the repository.

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

Returns the object’s tag, if present.

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

Returns the object’s digest, if present.

pub fn whole(&self) -> String

Returns the whole reference.

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<'de> Deserialize<'de> for Reference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reference

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

Formats the value using the given formatter.

impl From<Reference> for String

fn from(reference: Reference) -> Self

Converts to this type from the input type.

impl FromStr for Reference

type Err = ParseError

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

Feeds a slice of this type into the given Hasher.

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 Serialize for Reference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Reference

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Reference

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Reference

impl StructuralPartialEq for Reference