Struct Union 

pub struct Union {
    pub types: AtomicVec,
    pub possibly_undefined: bool,
    pub from_docblock: bool,
}

Fields

types: AtomicVec

possibly_undefined: bool

The variable holding this type may not be initialized at this point.

from_docblock: bool

This union originated from a docblock annotation rather than inference.

Implementations

impl Union

pub fn empty() -> Self

pub fn single(atomic: Atomic) -> Self

pub fn mixed() -> Self

pub fn void() -> Self

pub fn never() -> Self

pub fn null() -> Self

pub fn bool() -> Self

pub fn int() -> Self

pub fn float() -> Self

pub fn string() -> Self

pub fn nullable(atomic: Atomic) -> Self

T|null

pub fn from_vec(atomics: Vec<Atomic>) -> Self

Build a union from multiple atomics, de-duplicating on the fly.

pub fn is_empty(&self) -> bool

pub fn is_single(&self) -> bool

pub fn is_nullable(&self) -> bool

pub fn is_mixed(&self) -> bool

pub fn is_never(&self) -> bool

pub fn is_void(&self) -> bool

pub fn can_be_falsy(&self) -> bool

pub fn can_be_truthy(&self) -> bool

pub fn contains<F: Fn(&Atomic) -> bool>(&self, f: F) -> bool

pub fn has_named_object(&self, fqcn: &str) -> bool

pub fn add_type(&mut self, atomic: Atomic)

Add an atomic to this union, skipping duplicates. Subsumption rules: anything ⊆ TMixed; TLiteralInt ⊆ TInt; etc.

pub fn remove_null(&self) -> Union

Remove null from the union (e.g. after a null check).

pub fn remove_false(&self) -> Union

Remove false from the union.

pub fn narrow_to_truthy(&self) -> Union

Keep only truthy atomics (e.g. after if ($x)).

pub fn narrow_to_falsy(&self) -> Union

Keep only falsy atomics (e.g. after if (!$x)).

pub fn narrow_instanceof(&self, class: &str) -> Union

Narrow this type as if $x instanceof ClassName is true.

The instanceof check guarantees the value IS an instance of class, so we replace any object / mixed constituents with the specific named object. Scalar constituents are dropped (they can never satisfy instanceof).

pub fn narrow_to_string(&self) -> Union

Narrow as if is_string($x) is true.

pub fn narrow_to_int(&self) -> Union

Narrow as if is_int($x) is true.

pub fn narrow_to_float(&self) -> Union

Narrow as if is_float($x) is true.

pub fn narrow_to_bool(&self) -> Union

Narrow as if is_bool($x) is true.

pub fn narrow_to_null(&self) -> Union

Narrow as if is_null($x) is true.

pub fn narrow_to_array(&self) -> Union

Narrow as if is_array($x) is true.

pub fn narrow_to_object(&self) -> Union

Narrow as if is_object($x) is true.

pub fn narrow_to_callable(&self) -> Union

Narrow as if is_callable($x) is true.

pub fn merge(a: &Union, b: &Union) -> Union

Merge two unions at a branch join point (e.g. after if/else). The result is the union of all types in both.

pub fn intersect_with(&self, other: &Union) -> Union

Intersect with another union: keep only types present in other, widening where self contains mixed (which is compatible with everything). Used for match-arm subject narrowing.

pub fn substitute_templates(&self, bindings: &HashMap<Arc<str>, Union>) -> Union

Replace template param references with their resolved types.

pub fn is_subtype_of_simple(&self, other: &Union) -> bool

Returns true if every atomic in self is a subtype of some atomic in other. Does not require a Codebase (no inheritance check); use the codebase-aware version in mir-analyzer for full checks.

pub fn possibly_undefined(self) -> Self

Mark this union as possibly-undefined and return it.

pub fn from_docblock(self) -> Self

Mark this union as coming from a docblock annotation.

Trait Implementations

impl Clone for Union

fn clone(&self) -> Union

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Union

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Union

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Union

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

Formats the value using the given formatter.

impl PartialEq for Union

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Union