Skip to main content

ImageRef

Struct ImageRef 

Source
pub struct ImageRef {
    pub registry: String,
    pub repository: String,
    pub tag: String,
    pub digest: String,
}
Expand description

Container image reference identifying a specific image to pull.

Digest is required. Every executable image reference in the workspace is content-addressed by sha256:<hex>. The tag is preserved as a human-readable identifier but is not the source of truth — registries return mutable tag → digest mappings and we don’t trust them for reproducibility. R438-T3 tightened digest: Option<String> → String to make unpinned-image bugs impossible by construction.

Two deserialize shapes. The struct form (registry/repository/tag/digest fields) is the on-disk envelope. A string form (image = "ghcr.io/foo/bar:v1@sha256:<hex>") is also accepted and is the shape W164 transform recipes (R438-T4) and W165 BuildMode::InContainer (R438-T6) use. Both shapes go through a single parser ([compose_import::parse_pinned_image_ref]) that rejects bare-tag references at serde-deserialize.

Fields§

§registry: String

Registry hostname, e.g. "ghcr.io" or "localhost:5000".

§repository: String

Repository path, e.g. "noisetable/api".

§tag: String

Tag, e.g. "v1.4.2" or "latest". Informational — the digest is the source of truth for image identity.

§digest: String

Content-addressed pinned identity, e.g. "sha256:abc...". Required.

Implementations§

Source§

impl ImageRef

Source

pub const UNPINNED_DIGEST: &'static str = "sha256:0000000000000000000000000000000000000000000000000000000000000000"

The all-zeros sha256 digest that marks an image reference as not content-pinned. No real image can carry it, so a build that never injected a compile-time digest (dev builds) or a catalog image that isn’t published-and-pinned yet lands on this sentinel. This is the single source of truth both the catalog emitter (task::default_image::catalog_image, which writes it) and the container-runtime resolvers (Self::pull_ref, via kamaji) agree on — keeping them here means they cannot drift. [testing::TEST_DIGEST] is the same value re-exported for fixtures.

Source

pub fn parse_pinned(s: &str) -> Result<Self, String>

Parse a full digest-pinned image reference — [registry/]repo[:tag]@sha256:<hex> — into its parts.

This is the public door onto the same parser the ImageRef string-form Deserialize arm uses, so a config that spells an image as one string (a qed step.image, a transform recipe) and a config that spells it as a struct land on identical semantics. A bare tag is rejected: the whole point of the string form is that it carries the digest.

Source

pub fn docker_ref(&self) -> String

Format this reference as a Docker-compatible image string, {registry}/{repository}:{tag}@{digest}. Tag is included for human readability; the digest is what the pull resolves against. Always emits the digest — this is the display/logging form; use Self::pull_ref for the string handed to a container runtime.

Source

pub fn is_pinned(&self) -> bool

True when this reference carries a real content-addressed digest, i.e. its digest is not the all-zeros Self::UNPINNED_DIGEST sentinel.

Source

pub fn pull_ref(&self) -> String

The reference string to hand a container runtime for pull/resolve.

  • Pinned (real digest): {registry}/{repository}:{tag}@{digest} — content-addressed, the reproducible path.
  • Unpinned (all-zeros Self::UNPINNED_DIGEST): {registry}/{repository}:{tag} — tag-only. No registry or local store holds an image under the sentinel digest, so …@sha256:0000… can never resolve; a tag-pulled or locally-built image is keyed by registry/repo:tag. This is the tag-fallback path that lets a not-yet-published catalog image (e.g. a from-source build-worker image) still pull by tag.

Trait Implementations§

Source§

impl Clone for ImageRef

Source§

fn clone(&self) -> ImageRef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImageRef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ImageRef

Source§

fn deserialize<D>(de: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ImageRef

Source§

impl PartialEq for ImageRef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ImageRef

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ImageRef

Source§

impl TS for ImageRef

Source§

type WithoutGenerics = ImageRef

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None. Read more
Source§

type OptionInnerType = ImageRef

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.
Source§

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.
Source§

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes
Source§

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters
Source§

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().
Source§

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration. Read more
Source§

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.
Source§

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.
Source§

fn visit_generics(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all type parameters of this type.
Source§

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory. Read more
Source§

fn visit_dependencies(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all dependency of this type.
Source§

fn dependencies(cfg: &Config) -> Vec<Dependency>
where Self: 'static,

Resolves all dependencies of this type recursively.
Source§

fn export(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all. Read more
Source§

fn export_all(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export. Read more
Source§

fn export_to_string(cfg: &Config) -> Result<String, ExportError>
where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.