Struct bandsocks::ImageName

pub struct ImageName { /* fields omitted */ }

Parsed Docker-style image reference

This is an owned struct representing a docker "reference" (like a URI) which refers to an image, optionally at a specific version, which can be fetched from a registry server (possibly the configured default).

This tries to be format-compatible with Docker including its quirks.

A complete image name contains a Registry, Repository, Tag, and ContentDigest in that order. Only the Repository component is mandatory.

The Tag always begins with a : and the ContentDigest with an @, but delineating the optional Registry and the first section of the Repository requires heuristics. If this first section includes any dot (.) or colon (:) characters it is assumed to be a repository server. This same property (see Registry) ensures that the parsed registry uses https. The additional exception is a special case for "localhost", which is always interpreted as a registry name. Additionally, because it has no dots, it is interpreted as an unencrypted http registry at localhost.

When a ContentDigest is specified, it securely identifies the specific contents of an image's layer data and manifest. Remember that a name without a digest is only as trustworthy as the registry server and our connection to it.

Implementations

impl ImageName

pub fn as_str(&self) -> &str

Returns a reference to the existing string representation of an ImageName

pub fn from_parts(
    registry: Option<&str>,
    repository: &str,
    tag: Option<&str>,
    digest: Option<&str>
) -> Result<Self, ImageError>

Parse an ImageName from its component pieces

This may fail either because of a problem with one of the components, or because the resulting path would be parsed in a manner other than intended. For example, a registry name could be parsed as the first section of the repository path.

pub fn as_parts(&self) -> (Option<&str>, &str, Option<&str>, Option<&str>)

Return references to the parsed components within this ImageName

pub fn version(&self) -> ImageVersion

Returns the most specific available version

If the image name includes a digest, this returns the digest. Otherwise, it returns the tag, defaulting to latest if no tag is set.

pub fn parse(s: &str) -> Result<Self, ImageError>

Parse a str as an ImageName

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

Returns a reference to the optional registry portion of the string.

pub fn repository_str(&self) -> &str

Returns a reference to the repository portion of the string

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

Returns a reference to the optional tag portion of the string.

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

Returns a reference to the optional digest portion of the string.

pub fn registry(&self) -> Option<Registry>

Returns the registry portion as a new object

pub fn repository(&self) -> Repository

Returns the repository portion as a new object

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

Returns the tag portion as a new object

pub fn content_digest(&self) -> Option<ContentDigest>

Returns the digest portion as a new object

pub fn with_found_digest(
    &self,
    found_digest: &ContentDigest
) -> Result<ImageName, ImageError>

Create a new ImageName which includes the actual content digest we found

If the name already includes a digest, it is validated. On mismatch, an appropriate error will be returned. On match, or if no validation was requested, this returns a new specific ImageName with the provided digest.

Trait Implementations

impl Clone for ImageName

pub fn clone(&self) -> ImageName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageName

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

Formats the value using the given formatter.

impl Display for ImageName

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

Formats the value using the given formatter.

impl Eq for ImageName

impl FromStr for ImageName

type Err = ImageError

The associated error which can be returned from parsing.

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

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

impl Hash for ImageName

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ImageName

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ImageName> for ImageName

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ImageName> for ImageName

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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