Skip to main content

PackManifest

Struct PackManifest 

Source
pub struct PackManifest {
    pub schema_version: SchemaVersion,
    pub name: String,
    pub type: PackType,
    pub version: Option<String>,
    pub depends_on: Vec<String>,
    pub children: Vec<ChildRef>,
    pub actions: Vec<Action>,
    pub teardown: Option<Vec<Action>>,
    pub extensions: BTreeMap<String, Value>,
}
Expand description

Top-level representation of a pack.yaml manifest.

Post-parse invariants:

  • schema_version == "1".
  • name matches ^[a-z][a-z0-9-]*$.
  • Unknown top-level keys are absent unless prefixed with x-.
  • Predicate trees within any action are depth-bounded by MAX_REQUIRE_DEPTH.

Fields§

§schema_version: SchemaVersion

Schema-version literal. Always SchemaVersion::current at v1.

§name: String

Pack name (validated).

§type: PackType

Pack-type discriminator.

§version: Option<String>

Optional semver-ish string; grex does not parse it further in Stage A.

§depends_on: Vec<String>

Names of packs this pack depends on. Empty default.

§children: Vec<ChildRef>

Child-pack references. Empty default.

§actions: Vec<Action>

Ordered actions to run. Empty-default (valid no-op).

§teardown: Option<Vec<Action>>

Explicit teardown.

None means the pack-type driver should default to reverse(actions) at execute time; Some(vec![]) means the author explicitly opted into a no-op teardown. Preserving that distinction matters for audit trails — Stage A does not execute but must round-trip it.

§extensions: BTreeMap<String, Value>

Unknown x-* extension keys. Preserved verbatim for downstream plugins.

Implementations§

Source§

impl PackManifest

Walk every action (including those nested inside when blocks), yielding (global_index, &symlink) pairs.

global_index is a 0-based counter across the flattened action-walk — it is not the top-level index into PackManifest::actions. Two symlinks at the same top-level index but at different nesting depths receive distinct global indices. This is the index space PackValidationError variants refer to.

Source

pub fn validate_plan(&self) -> Result<(), Vec<PackValidationError>>

Run every default Validator over this manifest.

Returns Ok(()) when no validator emits an error; otherwise returns Err(Vec<_>) carrying every error across every validator (not fail-first — downstream consumers can decide whether to abort on the first or surface the full batch).

§Errors

Returns PackValidationError variants aggregated across the validator set. See validate::run_all for the exact default set.

§Example
use grex_core::pack::parse;

let src = "schema_version: \"1\"\nname: ok\ntype: declarative\n";
let pack = parse(src).unwrap();
pack.validate_plan().unwrap();

Trait Implementations§

Source§

impl Clone for PackManifest

Source§

fn clone(&self) -> PackManifest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PackManifest

Source§

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

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

impl PartialEq for PackManifest

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PackManifest

Source§

impl StructuralPartialEq for PackManifest

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<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<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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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