Struct ImageReference 

pub struct ImageReference { /* private fields */ }

A parsed OCI image reference with optional tag and digest.

Implementations

impl ImageReference

pub fn parse(value: impl AsRef<str>) -> Result<ImageReference, ReferenceError>

Parses image reference text.

pub const fn name(&self) -> &ImageName

Returns the image name.

pub const fn registry(&self) -> Option<&RegistryHost>

Returns the optional registry.

pub const fn repository(&self) -> &RepositoryName

Returns the repository.

Examples found in repository

examples/basic_usage.rs (line 20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let parsed_digest: digest::OciDigest =
        "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;
    let descriptor = descriptor::OciDescriptor::new(
        media_type::OciMediaType::image_manifest(),
        parsed_digest,
        descriptor::DescriptorSize::new(7023),
    );
    let linux_arm64 =
        platform::OciPlatform::new(platform::OciOs::Linux, platform::OciArchitecture::Arm64);
    let title = annotation::Annotation::title("RustUse OCI example")?;
    let image_ref: reference::ImageReference =
        "ghcr.io/rustuse/app:0.1.0@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".parse()?;

    assert_eq!(descriptor.size().as_u64(), 7023);
    assert_eq!(linux_arm64.to_string(), "linux/arm64");
    assert_eq!(title.value().as_str(), "RustUse OCI example");
    assert_eq!(image_ref.repository().as_str(), "rustuse/app");
    Ok(())
}

pub const fn tag(&self) -> Option<&OciTag>

Returns the optional tag.

pub const fn digest(&self) -> Option<&OciDigest>

Returns the optional digest.

pub fn as_str(&self) -> &str

Returns the normalized reference text.

Trait Implementations

impl Clone for ImageReference

fn clone(&self) -> ImageReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageReference

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

Formats the value using the given formatter.

impl Display for ImageReference

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

Formats the value using the given formatter.

impl FromStr for ImageReference

type Err = ReferenceError

The associated error which can be returned from parsing.

fn from_str( value: &str, ) -> Result<ImageReference, <ImageReference as FromStr>::Err>

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

impl Hash for ImageReference

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for ImageReference

fn cmp(&self, other: &ImageReference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ImageReference

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

fn partial_cmp(&self, other: &ImageReference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for ImageReference

type Error = ReferenceError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<ImageReference, <ImageReference as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for ImageReference

impl StructuralPartialEq for ImageReference