Struct FunctionNode 

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

Salsa input representing a single global function.

inferred_return_type is the Pass-2-derived return type, populated per-function by the priming sweep. It is committed to Salsa serially after the parallel sweep returns (so worker db clones have dropped and Storage::cancel_others sees strong-count==1). The buffer-and- commit pattern lives in [InferredReturnTypes] and MirDb::commit_inferred_return_types.

Invariant: every FQN known to the Salsa DB has exactly one FunctionNode handle in MirDb::function_nodes. Removed functions are marked active = false rather than dropped.

Implementations

impl FunctionNode

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

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

impl FunctionNode

pub fn new<Db_>( db: &Db_, fqn: Arc<str>, short_name: Arc<str>, active: bool, params: Arc<[FnParam]>, return_type: Option<Arc<Union>>, inferred_return_type: Option<Arc<Union>>, template_params: Arc<[TemplateParam]>, assertions: Arc<[Assertion]>, throws: Arc<[Arc<str>]>, deprecated: Option<Arc<str>>, is_pure: bool, location: Option<Location>, ) -> Self

where Db_: ?Sized + Database,

pub fn builder( fqn: Arc<str>, short_name: Arc<str>, active: bool, params: Arc<[FnParam]>, return_type: Option<Arc<Union>>, inferred_return_type: Option<Arc<Union>>, template_params: Arc<[TemplateParam]>, assertions: Arc<[Assertion]>, throws: Arc<[Arc<str>]>, deprecated: Option<Arc<str>>, is_pure: bool, location: Option<Location>, ) -> <Self as HasBuilder>::Builder

pub fn fqn<'db, Db_>(self, db: &'db Db_) -> Arc<str>

where Db_: ?Sized + Database,

pub fn short_name<'db, Db_>(self, db: &'db Db_) -> Arc<str>

where Db_: ?Sized + Database,

pub fn active<'db, Db_>(self, db: &'db Db_) -> bool

where Db_: ?Sized + Database,

pub fn params<'db, Db_>(self, db: &'db Db_) -> Arc<[FnParam]>

where Db_: ?Sized + Database,

pub fn return_type<'db, Db_>(self, db: &'db Db_) -> Option<Arc<Union>>

where Db_: ?Sized + Database,

pub fn inferred_return_type<'db, Db_>(self, db: &'db Db_) -> Option<Arc<Union>>

where Db_: ?Sized + Database,

pub fn template_params<'db, Db_>(self, db: &'db Db_) -> Arc<[TemplateParam]>

where Db_: ?Sized + Database,

pub fn assertions<'db, Db_>(self, db: &'db Db_) -> Arc<[Assertion]>

where Db_: ?Sized + Database,

pub fn throws<'db, Db_>(self, db: &'db Db_) -> Arc<[Arc<str>]>

where Db_: ?Sized + Database,

pub fn deprecated<'db, Db_>(self, db: &'db Db_) -> Option<Arc<str>>

where Db_: ?Sized + Database,

pub fn is_pure<'db, Db_>(self, db: &'db Db_) -> bool

where Db_: ?Sized + Database,

pub fn location<'db, Db_>(self, db: &'db Db_) -> Option<Location>

where Db_: ?Sized + Database,

Source location of the declaration. None for functions registered without a known origin (e.g. some legacy test fixtures).

pub fn set_fqn<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<str>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_short_name<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<str>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_active<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = bool> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_params<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<[FnParam]>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_return_type<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<Arc<Union>>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_inferred_return_type<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<Arc<Union>>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_template_params<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<[TemplateParam]>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_assertions<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<[Assertion]>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_throws<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Arc<[Arc<str>]>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_deprecated<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<Arc<str>>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_is_pure<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = bool> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_location<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<Location>> + use<'db, Db_>

where Db_: ?Sized + Database,

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

where for<'__trivial_bounds, '__trivial_bounds> Arc<str>: Debug, for<'__trivial_bounds, '__trivial_bounds> bool: Debug, for<'__trivial_bounds> Arc<[FnParam]>: Debug, for<'__trivial_bounds, '__trivial_bounds> Option<Arc<Union>>: Debug, for<'__trivial_bounds> Arc<[TemplateParam]>: Debug, for<'__trivial_bounds> Arc<[Assertion]>: Debug, for<'__trivial_bounds> Arc<[Arc<str>]>: Debug, for<'__trivial_bounds> Option<Arc<str>>: Debug, for<'__trivial_bounds> Option<Location>: Debug,

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

Trait Implementations

impl AsId for FunctionNode

fn as_id(&self) -> Id

impl Clone for FunctionNode

fn clone(&self) -> FunctionNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for FunctionNode

const LOCATION: Location

const DEBUG_NAME: &'static str = "FunctionNode"

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

The input struct (which wraps an Id)

type Fields = (Arc<str>, Arc<str>, bool, Arc<[FnParam]>, Option<Arc<Union>>, Option<Arc<Union>>, Arc<[TemplateParam]>, Arc<[Assertion]>, Arc<[Arc<str>]>, Option<Arc<str>>, bool, Option<Location>)

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

type Revisions = [Revision; 12]

type Durabilities = [Durability; 12]

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 FromId for FunctionNode

fn from_id(id: Id) -> Self

impl HasBuilder for FunctionNode

type Builder = Builder_

impl HasJar for FunctionNode

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

The [JarKind] for Self::Jar.

type Jar = JarImpl<FunctionNode>

The [Jar] associated with this ingredient.

impl Hash for FunctionNode

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 FunctionNode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl SalsaStructInDb for FunctionNode

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 Update for FunctionNode

unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool

Returns

impl Copy for FunctionNode

impl Eq for FunctionNode

impl StructuralPartialEq for FunctionNode