Enum TypeKind 

pub enum TypeKind {
    Union {
        kinds: Vec<TypeKind>,
    },
    Intersection {
        kinds: Vec<TypeKind>,
    },
    Scalar(ScalarTypeKind),
    Object(ObjectTypeKind),
    Array(ArrayTypeKind),
    Callable(CallableTypeKind),
    Value(ValueTypeKind),
    Conditional {
        parameter: Box<TypeKind>,
        condition: Box<TypeKind>,
        then: Box<TypeKind>,
        otherwise: Box<TypeKind>,
    },
    KeyOf {
        kind: Box<TypeKind>,
    },
    ValueOf {
        kind: Box<TypeKind>,
    },
    PropertiesOf {
        kind: Box<TypeKind>,
    },
    ClassStringMap {
        key: Template,
        value_kind: Box<TypeKind>,
    },
    Index {
        base_kind: Box<TypeKind>,
        index_kind: Box<TypeKind>,
    },
    Variable {
        name: StringIdentifier,
    },
    Iterable {
        key: Box<TypeKind>,
        value: Box<TypeKind>,
    },
    Void,
    Resource,
    ClosedResource,
    Mixed {
        explicit: bool,
    },
    Never,
    GenericParameter {
        name: StringIdentifier,
        of: Box<TypeKind>,
        defined_in: StringIdentifier,
    },
}

Represents all possible types in the PHP static analyzer.

Variants

Union

A union type, representing a value that can be any of the included types. For example, T | U.

Fields

kinds: Vec<TypeKind>

Intersection

An intersection type, representing a value that satisfies all of the included types. For example, T & U.

Fields

kinds: Vec<TypeKind>

Scalar(ScalarTypeKind)

A scalar type, such as int, string, bool, or specialized scalar types.

Object(ObjectTypeKind)

An object type, including specific instances and generic types.

Array(ArrayTypeKind)

An array type, including lists, shapes, and arrays with specified key and value types.

Callable(CallableTypeKind)

A callable type, representing functions, methods, and closures.

Value(ValueTypeKind)

A value type, including literals like strings, integers, and class constants.

Conditional

A conditional type, used for type inference based on a condition. For example, T extends U ? V : W.

Fields

parameter: Box<TypeKind>

The type being checked ( usually a generic parameter, or a variable ).

condition: Box<TypeKind>

The type used in the condition to compare against.

then: Box<TypeKind>

The type when the condition is true.

otherwise: Box<TypeKind>

The type when the condition is false.

KeyOf

Represents the keys of a type. For example, key-of<T> extracts the keys from type T.

Fields

kind: Box<TypeKind>

ValueOf

Represents the values of a type. For example, value-of<T> extracts the values from type T.

Fields

kind: Box<TypeKind>

PropertiesOf

Represents the properties of a type. For example, properties-of<T> extracts the properties from type T.

Fields

kind: Box<TypeKind>

ClassStringMap

A class-string-map type, mapping class strings to values of a specified type. For example, class-string-map<T of Foo, T> maps class names extending Foo to values of type T.

Fields

key: Template

The template parameter representing the class name, with constraints.

value_kind: Box<TypeKind>

The value type associated with the class string.

Index

An indexed access type, representing the type at a specific key. For example, T[K] accesses the type of property K in type T.

Fields

base_kind: Box<TypeKind>

index_kind: Box<TypeKind>

Variable

A variable type, representing a type associated with a variable. For example, $foo.

Fields

name: StringIdentifier

Iterable

An iterable type with specified key and value types. For example, iterable<string, int>.

Fields

key: Box<TypeKind>

value: Box<TypeKind>

Void

The void type, representing the absence of a value.

Resource

The resource type, representing a resource handle.

ClosedResource

The closed-resource type, representing a resource that has been closed (e.g., using fclose()).

Mixed

The mixed type, representing any type.

Fields

explicit: bool

Whether the mixed type is explicit, or inferred from context (e.g., a function with no return type).

Never

The never type, representing a type that never occurs (e.g., functions that always throw exceptions or exit).

GenericParameter

A generic parameter type, representing a type parameter with constraints.

Fields

name: StringIdentifier

of: Box<TypeKind>

defined_in: StringIdentifier

Implementations

impl TypeKind

pub fn is_nullable(&self) -> Trinary

pub fn is_object(&self) -> bool

pub fn is_resource(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_bool(&self) -> Trinary

pub fn is_truthy(&self) -> Trinary

pub fn is_falsy(&self) -> Trinary

pub fn is_float(&self) -> Trinary

pub fn is_integer(&self) -> Trinary

pub fn is_string(&self) -> Trinary

pub fn is_non_empty_string(&self) -> Trinary

pub fn is_value(&self) -> bool

pub fn is_templated_as_object(&self) -> bool

pub fn is_generator(&self) -> bool

pub fn get_key(&self, interner: &ThreadedInterner) -> String

Trait Implementations

impl Clone for TypeKind

fn clone(&self) -> TypeKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TypeKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&FunctionLikeReflection> for TypeKind

fn from(reflection: &FunctionLikeReflection) -> Self

Converts to this type from the input type.

impl Hash for TypeKind

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 TypeKind

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

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

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

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 TypeKind

impl StructuralPartialEq for TypeKind