Enum TObject 

pub enum TObject {
    Any,
    Named(TNamedObject),
    Enum(TEnum),
    WithProperties(TObjectWithProperties),
    HasMethod(TObjectHasMethod),
    HasProperty(TObjectHasProperty),
}

Represents a PHP object type, distinguishing between the generic object and instances of specific named classes/interfaces/traits (which may include intersections).

Variants

Any

Represents the generic object type, accepting any object instance.

Named(TNamedObject)

Represents an instance of a specific named class/interface/trait, potentially with generic parameters and intersection types (&).

Enum(TEnum)

Represents a specific enum type (unit or backed).

WithProperties(TObjectWithProperties)

Represents an object documented via object{...} doc comment

HasMethod(TObjectHasMethod)

Represents an object with a known method from method_exists() check.

HasProperty(TObjectHasProperty)

Represents an object with a known property from property_exists() check.

Implementations

impl TObject

pub const fn new_any() -> Self

Creates a new Object representing the generic object.

pub const fn new_with_properties( sealed: bool, known_properties: BTreeMap<Atom, (bool, TUnion)>, ) -> Self

Creates a new Object representing an object with specific known properties.

The sealed flag indicates whether the object is sealed (no additional properties will exist beyond those known).

The known_properties map defines specific types for certain keys (Atom), where the bool indicates if the property is optional.

pub fn new_named(name: Atom) -> Self

Creates a new Object representing a specific named object type (default flags).

pub fn new_named_this(name: Atom) -> Self

Creates a new Object representing $this for a given class name.

pub fn new_enum(name: Atom) -> Self

Creates a new TObject representing an enum.

pub fn new_enum_case(name: Atom, case: Atom) -> Self

Creates a new TObject representing an enum case.

pub const fn new_has_method(method: Atom) -> Self

Creates a new TObject representing an object with a known method.

pub const fn new_has_property(property: Atom) -> Self

Creates a new TObject representing an object with a known property.

pub const fn is_any(&self) -> bool

Checks if this represents the generic object type.

pub const fn is_named(&self) -> bool

Checks if this represents a specific named object type (including intersections).

pub const fn is_enum(&self) -> bool

Checks if this represents a specific enum type.

pub const fn has_name(&self) -> bool

Checks if this represents an object that has a name.

pub const fn is_has_method(&self) -> bool

Checks if this is a HasMethod variant.

pub const fn is_has_property(&self) -> bool

Checks if this is a HasProperty variant.

pub const fn get_has_method_type(&self) -> Option<&TObjectHasMethod>

Returns a reference to the TObjectHasMethod data if this is a HasMethod variant.

pub fn get_has_method_type_mut(&mut self) -> Option<&mut TObjectHasMethod>

Returns a mutable reference to the TObjectHasMethod data if this is a HasMethod variant.

pub const fn get_has_property_type(&self) -> Option<&TObjectHasProperty>

Returns a reference to the TObjectHasProperty data if this is a HasProperty variant.

pub fn get_has_property_type_mut(&mut self) -> Option<&mut TObjectHasProperty>

Returns a mutable reference to the TObjectHasProperty data if this is a HasProperty variant.

pub const fn get_named_object_type(&self) -> Option<&TNamedObject>

Returns a reference to the NamedObject data if this is a Named variant.

pub fn get_named_object_type_mut(&mut self) -> Option<&mut TNamedObject>

Returns a mutable reference to the NamedObject data if this is a Named variant.

pub const fn get_enum_type(&self) -> Option<&TEnum>

Returns a reference to the Enum data if this is an Enum variant.

pub fn get_enum_type_mut(&mut self) -> Option<&mut TEnum>

Returns a mutable reference to the Enum data if this is an Enum variant.

pub const fn get_name(&self) -> Option<&Atom>

Returns the primary name identifier if this is a Named or Enum variant.

pub fn get_type_parameters(&self) -> Option<&[TUnion]>

Returns the type parameters of the named object if it has any.

pub fn get_intersection_types(&self) -> Option<&[TAtomic]>

Returns a slice of the additional intersection types if this supports them.

Trait Implementations

impl Clone for TObject

fn clone(&self) -> TObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TObject

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 TObject

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TType for TObject

fn get_child_nodes(&self) -> Vec<TypeRef<'_>>

Returns a vector of child type nodes that this type contains.

fn can_be_intersected(&self) -> bool

Checks if this type can have intersection types (&B&S).

fn get_intersection_types(&self) -> Option<&[TAtomic]>

Returns a slice of the additional intersection types (&B&S), if any. Contains boxed atomic types.

fn get_intersection_types_mut(&mut self) -> Option<&mut Vec<TAtomic>>

Returns a mutable slice of the additional intersection types (&B&S), if any. Contains boxed atomic types.

fn has_intersection_types(&self) -> bool

Checks if this type has intersection types.

fn add_intersection_type(&mut self, intersection_type: TAtomic) -> bool

Adds an intersection type to this type.

fn needs_population(&self) -> bool

fn is_expandable(&self) -> bool

fn is_complex(&self) -> bool

Returns true if this type has complex structure that benefits from multiline formatting when used as a generic parameter.

fn get_id(&self) -> Atom

Return a human-readable atom for this type, which is suitable for use in error messages or debugging.

fn get_pretty_id_with_indent(&self, indent: usize) -> Atom

fn get_all_child_nodes(&self) -> Vec<TypeRef<'_>>

Returns a vector of all child type nodes, including nested ones.

fn get_pretty_id(&self) -> Atom

impl Eq for TObject

impl StructuralPartialEq for TObject