Struct FunctionLikeMetadata

pub struct FunctionLikeMetadata {

    pub kind: FunctionLikeKind,
    pub span: Span,
    pub name: Option<StringIdentifier>,
    pub name_span: Option<Span>,
    pub parameters: Vec<FunctionLikeParameterMetadata>,
    pub return_type_declaration_metadata: Option<TypeMetadata>,
    pub return_type_metadata: Option<TypeMetadata>,
    pub template_types: Vec<TemplateTuple>,
    pub attributes: Vec<AttributeMetadata>,
    pub method_metadata: Option<MethodMetadata>,
    pub type_resolution_context: Option<TypeResolutionContext>,
    pub thrown_types: Vec<TypeMetadata>,
    pub has_yield: bool,
    pub must_use: bool,
    pub has_throw: bool,
    pub specialize_call: bool,
    pub is_deprecated: bool,
    pub is_internal: bool,
    pub is_pure: bool,
    pub ignore_nullable_return: bool,
    pub ignore_falsable_return: bool,
    pub inherits_docs: bool,
    pub is_mutation_free: bool,
    pub is_external_mutation_free: bool,
    pub allows_named_arguments: bool,
    pub issues: Vec<Issue>,
    pub assertions: BTreeMap<StringIdentifier, Vec<Assertion>>,
    pub if_true_assertions: BTreeMap<StringIdentifier, Vec<Assertion>>,
    pub if_false_assertions: BTreeMap<StringIdentifier, Vec<Assertion>>,
    pub unchecked: bool,
    /* private fields */
}

Fields

kind: FunctionLikeKind

The kind of function-like structure this metadata represents.

span: Span

The source code location (span) covering the entire function/method/closure definition. For closures/arrow functions, this covers the function(...) { ... } or fn(...) => ... part.

name: Option<StringIdentifier>

The name of the function or method, if applicable. None for closures and arrow functions unless assigned to a variable later. Example: processRequest, __construct, my_global_func.

name_span: Option<Span>

The specific source code location (span) of the function or method name identifier. None if the function/method has no name (closures/arrow functions).

parameters: Vec<FunctionLikeParameterMetadata>

Ordered list of metadata for each parameter defined in the signature.

return_type_declaration_metadata: Option<TypeMetadata>

The explicit return type declaration (type hint).

Example: For function getName(): string, this holds metadata for string. None if no return type is specified.

return_type_metadata: Option<TypeMetadata>

The explicit return type declaration (type hint) or docblock type (@return).

Example: For function getName(): string, this holds metadata for string, or for /** @return string */ function getName() { .. }, this holds metadata for string. None if neither is specified.

template_types: Vec<TemplateTuple>

Generic type parameters (templates) defined for the function/method (e.g., @template T). Stores the template name and its constraints (parent type and bound type). Example: [("T", [(GenericParent::Function("funcName"), Arc<TUnion::object()>)])]

attributes: Vec<AttributeMetadata>

Attributes attached to the function/method/closure declaration (#[Attribute] function foo() {}).

method_metadata: Option<MethodMetadata>

Specific metadata relevant only to methods (visibility, final, static, etc.). This is Some if kind is FunctionLikeKind::Method, None otherwise.

type_resolution_context: Option<TypeResolutionContext>

Contains context information needed for resolving types within this function’s scope (e.g., use statements, current namespace, class context). Often populated during analysis.

thrown_types: Vec<TypeMetadata>

A list of types that this function/method might throw, derived from @throws docblock tags or inferred from throw statements within the body.

has_yield: bool

true if the function/method body contains a yield statement, indicating it’s a generator.

must_use: bool

true if the function/method is marked with @psalm-must-use, @phpstan-must-use, or @must-use, indicating its return value should not be ignored.

has_throw: bool

true if the function/method body contains a throw statement.

specialize_call: bool

is_deprecated: bool

true if the function/method is marked as deprecated via docblock tags (@deprecated, @psalm-deprecated, @phpstan-deprecated).

is_internal: bool

true if the function/method is marked as internal via docblock tags (@internal, @psalm-internal, @phpstan-internal), indicating it’s not part of the lic API.

is_pure: bool

true if the function/method is marked as pure via docblock tags (@pure, @psalm-pure, @phpstan-pure), indicating it has no side effects.

ignore_nullable_return: bool

true if marked with @psalm-ignore-nullable-return or equivalent, suppressing issues related to returning null when the signature doesn’t explicitly allow it.

ignore_falsable_return: bool

true if marked with @psalm-ignore-falsable-return or equivalent, suppressing issues related to returning false when the signature doesn’t explicitly allow it.

inherits_docs: bool

true if the function/method’s docblock includes {@inheritdoc} or implicitly inherits documentation from a parent method.

is_mutation_free: bool

true if marked with @psalm-mutation-free, @phpstan-mutation-free, indicating the function does not modify any state (including object properties or global state). Implies @pure.

is_external_mutation_free: bool

true if marked with @psalm-external-mutation-free, @phpstan-external-mutation-free, indicating the function does not modify external state but may modify its own arguments or locally created objects.

allows_named_arguments: bool

true if the function/method accepts named arguments (PHP 8.0+ default). Can be set to false if the #[NoNamedArguments] attribute is present (PHP 8.2+).

issues: Vec<Issue>

List of issues specifically related to parsing or interpreting this function’s docblock.

assertions: BTreeMap<StringIdentifier, Vec<Assertion>>

Assertions about parameter types or variable types that are guaranteed to be true after this function/method returns normally. From @psalm-assert, @phpstan-assert, etc. Maps variable/parameter name to a list of type assertions.

if_true_assertions: BTreeMap<StringIdentifier, Vec<Assertion>>

Assertions about parameter/variable types that are guaranteed to be true if this function/method returns true. From @psalm-assert-if-true, etc.

if_false_assertions: BTreeMap<StringIdentifier, Vec<Assertion>>

Assertions about parameter/variable types that are guaranteed to be true if this function/method returns false. From @psalm-assert-if-false, etc.

unchecked: bool

A flag indicating if this function-like should be treated as unchecked.

Implementations

impl FunctionLikeMetadata

Contains comprehensive metadata for any function-like structure in PHP. Provides a flexible API with setters (set_*), consuming builders (with_*), adders (add_*), consuming adders (with_added_*), unsetters (unset_*), and consuming unsetters (without_*), along with clearly named getters (get_*, is_*, has_*, allows_*).

pub fn new(kind: FunctionLikeKind, span: Span) -> Self

Creates new FunctionLikeMetadata with basic information and default flags.

pub fn get_kind(&self) -> FunctionLikeKind

Returns the kind of function-like (Function, Method, Closure, ArrowFunction).

pub fn get_parameters_mut(&mut self) -> &mut [FunctionLikeParameterMetadata]

Returns a mutable slice of the parameter metadata.

pub fn get_parameter( &self, name: StringIdentifier, ) -> Option<&FunctionLikeParameterMetadata>

Returns a reference to specific parameter metadata by name, if it exists.

pub fn get_parameter_mut( &mut self, name: StringIdentifier, ) -> Option<&mut FunctionLikeParameterMetadata>

Returns a mutable reference to specific parameter metadata by name, if it exists.

pub fn get_template_types_mut(&mut self) -> &mut [TemplateTuple]

Returns a mutable slice of the template type parameters.

pub fn get_attributes(&self) -> &[AttributeMetadata]

Returns a slice of the attributes.

pub fn get_method_metadata_mut(&mut self) -> Option<&mut MethodMetadata>

Returns a mutable reference to the method-specific info, if this is a method.

pub fn take_issues(&mut self) -> Vec<Issue>

Returns a mutable slice of docblock issues.

pub const fn has_yield(&self) -> bool

Checks if the function contains yield.

pub fn set_name( &mut self, name: Option<StringIdentifier>, name_span: Option<Span>, )

Sets the name and corresponding name span. Clears both if name is None. Updates constructor status.

pub fn with_name( self, name: Option<StringIdentifier>, name_span: Option<Span>, ) -> Self

Returns a new instance with the name and name span set. Updates constructor status.

pub fn unset_name(&mut self)

Sets the name and name span to None. Updates constructor status.

pub fn set_parameters( &mut self, parameters: impl IntoIterator<Item = FunctionLikeParameterMetadata>, )

Sets the parameters, replacing existing ones.

pub fn with_parameters( self, parameters: impl IntoIterator<Item = FunctionLikeParameterMetadata>, ) -> Self

Returns a new instance with the parameters replaced.

pub fn set_return_type_metadata(&mut self, return_type: Option<TypeMetadata>)

pub fn set_return_type_declaration_metadata( &mut self, return_type: Option<TypeMetadata>, )

pub fn add_template_type(&mut self, template: TemplateTuple)

Adds a single template type definition.

Trait Implementations

impl Clone for FunctionLikeMetadata

fn clone(&self) -> FunctionLikeMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionLikeMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionLikeMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionLikeMetadata

fn eq(&self, other: &FunctionLikeMetadata) -> 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 Serialize for FunctionLikeMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FunctionLikeMetadata

impl StructuralPartialEq for FunctionLikeMetadata