Struct FunctionLikeParameterMetadata 

#[non_exhaustive]
pub struct FunctionLikeParameterMetadata {
    pub attributes: Vec<AttributeMetadata>,
    pub name: VariableIdentifier,
    pub type_declaration_metadata: Option<TypeMetadata>,
    pub type_metadata: Option<TypeMetadata>,
    pub out_type: Option<TypeMetadata>,
    pub default_type: Option<TypeMetadata>,
    pub span: Span,
    pub name_span: Span,
    pub flags: MetadataFlags,
}

Contains metadata associated with a single parameter within a function, method, or closure signature.

This captures details like the parameter’s name, type hint, attributes, default value, pass-by-reference status, variadic nature, and other PHP features like property promotion.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attributes: Vec<AttributeMetadata>

Attributes attached to the parameter declaration.

name: VariableIdentifier

The identifier (name) of the parameter, including the leading ‘$’.

type_declaration_metadata: Option<TypeMetadata>

The native type declaration from the function signature.

This is the type hint specified in the code (e.g., string $name), not from docblocks. Can be None if no type hint is specified in the signature.

type_metadata: Option<TypeMetadata>

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

If there’s a docblock @param annotation, this will contain that type (with from_docblock=true). Otherwise, this will be the same as type_declaration_metadata. Can be None if no type is specified.

out_type: Option<TypeMetadata>

The type specified by a @param-out docblock tag.

This indicates the expected type of a pass-by-reference parameter after the function executes.

default_type: Option<TypeMetadata>

The inferred type of the parameter’s default value, if has_default is true and the type could be determined.

None if there is no default or the default value’s type couldn’t be inferred.

span: Span

The source code location (span) covering the entire parameter declaration.

name_span: Span

The specific source code location (span) of the parameter’s name identifier.

flags: MetadataFlags

Flags indicating various properties of the parameter.

Implementations

impl FunctionLikeParameterMetadata

Contains metadata associated with a single parameter within a function, method, or closure signature.

This captures details like the parameter’s name, type hint, attributes, default value, pass-by-reference status, variadic nature, and other PHP features like property promotion.

pub fn new( name: VariableIdentifier, span: Span, name_span: Span, flags: MetadataFlags, ) -> Self

Creates new FunctionLikeParameterMetadata for a basic parameter. Initializes most flags to false and optional fields to None.

Arguments

• name: The identifier (name) of the parameter (e.g., $userId).
• span: The source code location covering the entire parameter declaration.
• name_span: The source code location of the parameter’s name identifier ($userId).

pub fn get_name(&self) -> &VariableIdentifier

Returns a reference to the parameter’s name identifier (e.g., $userId).

pub fn get_span(&self) -> Span

Returns the span covering the entire parameter declaration.

pub fn get_name_span(&self) -> Span

Returns the span covering the parameter’s name identifier.

pub fn get_type_metadata(&self) -> Option<&TypeMetadata>

Returns a reference to the parameter’s type metadata (effective type with docblock).

pub fn get_type_declaration_metadata(&self) -> Option<&TypeMetadata>

Returns a reference to the parameter’s native type declaration metadata.

pub fn get_default_type(&self) -> Option<&TypeMetadata>

Returns a reference to the inferred type of the default value, if known.

pub fn set_attributes( &mut self, attributes: impl IntoIterator<Item = AttributeMetadata>, )

Sets the attributes, replacing any existing ones.

pub fn with_attributes( self, attributes: impl IntoIterator<Item = AttributeMetadata>, ) -> Self

Returns a new instance with the attributes replaced.

pub fn set_type_metadata(&mut self, type_metadata: Option<TypeMetadata>)

Sets the parameter’s type metadata (effective type with docblock).

pub fn set_type_declaration_metadata( &mut self, type_declaration: Option<TypeMetadata>, )

Sets the parameter’s native type declaration metadata.

If type_metadata is not set, it will be initialized with the same value.

Trait Implementations

impl Clone for FunctionLikeParameterMetadata

fn clone(&self) -> FunctionLikeParameterMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionLikeParameterMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionLikeParameterMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasSpan for FunctionLikeParameterMetadata

fn span(&self) -> Span

Returns the source span.

fn start_position(&self) -> Position

A convenience method to get the starting position of the span.

fn start_offset(&self) -> u32

A convenience method to get the starting byte offset of the span.

fn end_position(&self) -> Position

A convenience method to get the ending position of the span.

fn end_offset(&self) -> u32

A convenience method to get the ending byte offset of the span.

impl Hash for FunctionLikeParameterMetadata

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 FunctionLikeParameterMetadata

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

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 FunctionLikeParameterMetadata

impl StructuralPartialEq for FunctionLikeParameterMetadata