Skip to main content

CacheInstallOutcome

Struct CacheInstallOutcome 

Source
pub struct CacheInstallOutcome {
    pub mem_name: String,
    pub schema: SchemaRef,
    pub cache_path: PathBuf,
    pub cache_key: String,
    pub copied_to_cache: bool,
    pub schema_files: Vec<(String, Vec<u8>)>,
    pub warnings: Vec<WarningHint>,
}
Expand description

Install a sealed mem archive into the global cache and register it in a writable mem’s config. Accepts the .mem archive format.

Two independent side effects, both idempotent:

  1. If the content-addressed cache file does not exist: run the submitted bytes through validate_and_normalize_archive and write the validator’s canonical_bytes via a .tmp sibling + atomic rename. A mid-write crash leaves the temp file behind, never a partial cache file. Existing cache files are left untouched — overwrite-on-newer-version is an app-level update flow, not a CLI install semantic. Users who want to force-replace can delete the cache file first.
  2. If the target mem’s config does not already list this mem under readMems, add an entry with source: { type: "local" }. Existing entries are left untouched so re-running install never clobbers a type: "url" (etc.) source the user configured by hand.

The target parameter selects where the registration lands:

  • TargetMem::Disk(mem_dir) writes the updated config back to <mem_dir>/.memstead/config.json (legacy disk shape).
  • TargetMem::MemRepo { workspace_root, mem_name } commits the updated configs/<mem_name>.json to mem-repo-git:main (post- cutover shape).

ctx and commit_message are used only by the MemRepo arm — the disk arm rewrites the file via the existing config-update path which has its own (file-mtime-based) provenance trail.

Returns an InstallOutcome describing which effects fired. The authoritative mem name comes from the validator’s approved config, not from the submitted filename or caller argument. Outcome of install_to_cache — the cache-side half of an install, with everything the caller needs to register the archive as a workspace-level read-only mount.

Fields§

§mem_name: String

Mem name, taken from the validator’s approved config — the archive’s sole identity.

§schema: SchemaRef

The archive’s schema pin, from its bundled config.

§cache_path: PathBuf

Content-addressed cache file the mount’s Archive storage points at.

§cache_key: String

The content digest half of the cache filename.

§copied_to_cache: bool

true if canonical bytes were written on this call; false on the idempotent dedup path.

§schema_files: Vec<(String, Vec<u8>)>

The archive’s embedded schema package, package-relative (schema.yaml, types/<t>.yaml, schema-format.json) and byte-verbatim. Carried out of the validator because the mount that follows can only be registered once this schema resolves, and for a third party’s vocabulary the archive is the only place it exists. Empty when the archive embeds no schema tree.

§warnings: Vec<WarningHint>

Typed non-fatal issues surfaced by the install.

Trait Implementations§

Source§

impl Clone for CacheInstallOutcome

Source§

fn clone(&self) -> CacheInstallOutcome

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 CacheInstallOutcome

Source§

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

Formats the value using the given formatter. 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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more