Struct Package 

pub struct Package(/* private fields */);

One loaded package: its dotted name (e.g. veh.common), its files, where it came from, its own manifest’s [imports] map, and its interface lock.

imports is ADR-0002 §5 step 2: the [imports] of the manifest governing this package’s directory tree. It shadows the workspace [imports] for this package only — a member’s pin is never visible to a sibling member. Every package loaded from one manifest’s tree (the root and its subdirectory packages) carries that manifest’s map; a single-file package and ridl.std carry an empty map.

Implementations

impl Package

pub fn ingredient(db: &dyn Database) -> &IngredientImpl<Self>

pub fn ingredient_mut( zalsa_mut: &mut Zalsa, ) -> (&mut IngredientImpl<Self>, &mut Runtime)

impl Package

pub fn new<Db_>( db: &Db_, name: String, files: Vec<InputFile>, origin: PackageOrigin, imports: BTreeMap<String, String>, default_timing: Option<String>, lock: Option<PackageLock>, ) -> Self

where Db_: ?Sized + Database,

pub fn builder( name: String, files: Vec<InputFile>, origin: PackageOrigin, imports: BTreeMap<String, String>, default_timing: Option<String>, lock: Option<PackageLock>, ) -> <Self as HasBuilder>::Builder

pub fn name<'db, Db_>(self, db: &'db Db_) -> &'db String

where Db_: ?Sized + Database,

pub fn files<'db, Db_>(self, db: &'db Db_) -> &'db Vec<InputFile>

where Db_: ?Sized + Database,

pub fn origin<'db, Db_>(self, db: &'db Db_) -> &'db PackageOrigin

where Db_: ?Sized + Database,

pub fn imports<'db, Db_>(self, db: &'db Db_) -> &'db BTreeMap<String, String>

where Db_: ?Sized + Database,

pub fn default_timing<'db, Db_>(self, db: &'db Db_) -> &'db Option<String>

where Db_: ?Sized + Database,

The raw [defaults].timing string that governs this package (ADR-0002 §5 precedence: package [defaults] shadows workspace [defaults], merged at load), or None when no manifest configures one — the checker then applies the built-in [100ms..1000ms] (ridl §9.1). Stored unparsed: ridl-core cannot depend on ridl-sem (E2 task 9).

pub fn lock<'db, Db_>(self, db: &'db Db_) -> &'db Option<PackageLock>

where Db_: ?Sized + Database,

The package’s interfaces.lock, read by the loader from the package directory (lock design §2), or None when the directory has no such file, when the file is malformed (the loader reports RIDL-410 and drops it), or when the package was not loaded from a directory (a source string, ridl.std). The checker reads it to give every interface its number; without it every number is provisional.

pub fn set_name<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = String>

where Db_: ?Sized + Database,

pub fn set_files<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Vec<InputFile>>

where Db_: ?Sized + Database,

pub fn set_origin<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = PackageOrigin>

where Db_: ?Sized + Database,

pub fn set_imports<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = BTreeMap<String, String>>

where Db_: ?Sized + Database,

pub fn set_default_timing<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<String>>

where Db_: ?Sized + Database,

pub fn set_lock<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<PackageLock>>

where Db_: ?Sized + Database,

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'__trivial_bounds> String: Debug, for<'__trivial_bounds> Vec<InputFile>: Debug, for<'__trivial_bounds> PackageOrigin: Debug, for<'__trivial_bounds> BTreeMap<String, String>: Debug, for<'__trivial_bounds> Option<String>: Debug, for<'__trivial_bounds> Option<PackageLock>: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

Trait Implementations

impl AsId for Package

fn as_id(&self) -> Id

impl Clone for Package

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for Package

const LOCATION: Location

const DEBUG_NAME: &'static str = "Package"

const FIELD_DEBUG_NAMES: &'static [&'static str]

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Singleton = NotSingleton

The singleton state for this input if any.

type Struct = Package

The input struct (which wraps an Id)

type Fields = (String, Vec<InputFile>, PackageOrigin, BTreeMap<String, String>, Option<String>, Option<PackageLock>)

A (possibly empty) tuple of the fields for this struct.

type Revisions = [Revision; 6]

type Durabilities = [Durability; 6]

fn serialize<S: Serializer>( fields: &Self::Fields, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

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

Deserialize the fields using serde.

fn heap_size(_value: &Self::Fields) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

impl Copy for Package

impl Debug for Package

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

Formats the value using the given formatter.

impl Eq for Package

impl FromId for Package

fn from_id(id: Id) -> Self

impl HasBuilder for Package

type Builder = Builder_

impl HasJar for Package

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<Package>

The [Jar] associated with this ingredient.

impl Hash for Package

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

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 PartialEq for Package

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

Equality operator ==.

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

Inequality operator !=.

impl SalsaStructInDb for Package

const LEAF_TYPE_IDS: &'static [ConstTypeId]

The type IDs of all concrete (leaf) salsa struct types that this type can contain.

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl SalsaValue for Package

impl StructuralPartialEq for Package