Struct TCallableSignature 

pub struct TCallableSignature {
    pub is_pure: bool,
    pub is_closure: bool,
    pub parameters: Vec<TCallableParameter>,
    pub return_type: Option<Box<TUnion>>,
    pub closure_location: Option<(FileId, Position)>,
    pub source: Option<FunctionLikeIdentifier>,
}

Represents the detailed signature of a PHP callable type.

This includes parameter types and flags, return type, and purity information, often derived from @param callable(ParamType...): ReturnType docblock tags or inferred from usage.

Fields

is_pure: bool

true if the callable is known to be pure (no side effects), often from @psalm-pure.

is_closure: bool

true if this signature specifically represents a closure instance. May overlap with closure_position being Some.

parameters: Vec<TCallableParameter>

Ordered list of parameters expected by the callable signature.

return_type: Option<Box<TUnion>>

The return type of the callable, if specified. None implies mixed or unknown.

closure_location: Option<(FileId, Position)>

The source code starting position if this signature originated from a specific closure definition. None if it represents a general callable type not tied to a specific closure literal.

source: Option<FunctionLikeIdentifier>

The source of the callable, if it is an alias or reference to another function-like construct.

Implementations

impl TCallableSignature

pub fn new(is_pure: bool, is_closure: bool) -> Self

Creates a new CallableSignature with the specified purity and closure status.

pub fn mixed(is_closure: bool) -> Self

pub fn get_parameters(&self) -> &[TCallableParameter]

Returns a slice of the callable parameters.

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

Returns a mutable slice of the callable parameters.

pub fn get_return_type(&self) -> Option<&TUnion>

Returns a reference to the return type (TUnion), if specified.

pub fn get_return_type_mut(&mut self) -> Option<&mut TUnion>

Returns a mutable reference to the return type (TUnion), if specified.

pub fn get_closure_position(&self) -> Option<(FileId, Position)>

Returns the closure’s starting position, if this signature represents a specific closure literal.

pub const fn is_pure(&self) -> bool

Checks if the callable is marked as pure.

pub const fn is_closure(&self) -> bool

Checks if this signature specifically represents a closure.

pub const fn has_source(&self) -> bool

Checks if the callable has a source, indicating it is an alias or reference to another function-like construct.

pub fn get_source(&self) -> Option<FunctionLikeIdentifier>

Returns the source of the callable, if it is an alias or reference to another function-like construct.

pub fn clone_as_closure(&self) -> Self

Clones the signature as a closure, setting is_closure to true.

pub fn with_pure(self, is_pure: bool) -> Self

Returns a new instance with is_pure set to the given value.

pub fn with_parameters(self, parameters: Vec<TCallableParameter>) -> Self

Returns a new instance with the given parameters.

pub fn with_return_type(self, return_type: Option<Box<TUnion>>) -> Self

Returns a new instance with the return type set.

pub fn with_closure_location( self, closure_position: Option<(FileId, Position)>, ) -> Self

Returns a new instance with the closure position set.

pub fn with_source(self, source: Option<FunctionLikeIdentifier>) -> Self

Returns a new instance with the source set.

Trait Implementations

impl Clone for TCallableSignature

fn clone(&self) -> TCallableSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TCallableSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TCallableSignature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TCallableSignature

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 Ord for TCallableSignature

fn cmp(&self, other: &TCallableSignature) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TCallableSignature

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

fn partial_cmp(&self, other: &TCallableSignature) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TCallableSignature

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 TCallableSignature

impl StructuralPartialEq for TCallableSignature