Struct TUnion 

pub struct TUnion {
    pub types: Cow<'static, [TAtomic]>,
    pub flags: UnionFlags,
}

Fields

types: Cow<'static, [TAtomic]>

flags: UnionFlags

Implementations

impl TUnion

pub fn new(types: Cow<'static, [TAtomic]>) -> TUnion

The primary constructor for creating a TUnion from a Cow.

This is the most basic way to create a TUnion and is used by both the zero-allocation static helpers and the from_vec constructor.

pub fn from_vec(types: Vec<TAtomic>) -> TUnion

Creates a TUnion from an owned Vec, performing necessary cleanup.

This preserves the original logic for cleaning up dynamically created unions, such as removing redundant never types.

Panics

In debug builds, panics if:

• The input Vec is empty (unions must contain at least one type)
• The input contains a mix of never types with other types (invalid union construction)

pub fn from_single(atomic: Cow<'static, TAtomic>) -> TUnion

Creates a TUnion from a single atomic type, which can be either borrowed from a static source or owned.

This function is a key optimization point. When passed a Cow::Borrowed, it creates the TUnion without any heap allocation.

pub fn from_atomic(atomic: TAtomic) -> TUnion

Creates a TUnion from a single owned atomic type.

pub fn set_possibly_undefined( &mut self, possibly_undefined: bool, from_try: Option<bool>, )

pub const fn had_template(&self) -> bool

pub const fn by_reference(&self) -> bool

pub const fn reference_free(&self) -> bool

pub const fn possibly_undefined_from_try(&self) -> bool

pub const fn possibly_undefined(&self) -> bool

pub const fn ignore_nullable_issues(&self) -> bool

pub const fn ignore_falsable_issues(&self) -> bool

pub const fn from_template_default(&self) -> bool

pub const fn populated(&self) -> bool

pub fn set_had_template(&mut self, value: bool)

pub fn set_by_reference(&mut self, value: bool)

pub fn set_reference_free(&mut self, value: bool)

pub fn set_possibly_undefined_from_try(&mut self, value: bool)

pub fn set_ignore_nullable_issues(&mut self, value: bool)

pub fn set_ignore_falsable_issues(&mut self, value: bool)

pub fn set_from_template_default(&mut self, value: bool)

pub fn set_populated(&mut self, value: bool)

pub fn clone_with_types(&self, types: Vec<TAtomic>) -> TUnion

Creates a new TUnion with the same properties as the original, but with a new set of types.

pub fn to_non_nullable(&self) -> TUnion

pub fn to_truthy(&self) -> TUnion

pub fn get_non_nullable_types(&self) -> Vec<TAtomic>

pub fn get_truthy_types(&self) -> Vec<TAtomic>

pub fn as_nullable(self) -> TUnion

Adds null to the union type, making it nullable.

pub fn remove_type(&mut self, bad_type: &TAtomic)

Removes a specific atomic type from the union.

pub fn replace_type(&mut self, remove_type: &TAtomic, add_type: TAtomic)

Replaces a specific atomic type in the union with a new type.

pub fn is_int(&self) -> bool

pub fn has_int_or_float(&self) -> bool

pub fn has_int_and_float(&self) -> bool

pub fn has_int_and_string(&self) -> bool

pub fn has_int(&self) -> bool

pub fn has_float(&self) -> bool

pub fn is_array_key(&self) -> bool

pub fn is_any_string(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_always_array_key(&self, ignore_never: bool) -> bool

pub fn is_non_empty_string(&self) -> bool

pub fn is_empty_array(&self) -> bool

pub fn has_string(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn is_never(&self) -> bool

pub fn is_never_template(&self) -> bool

pub fn is_placeholder(&self) -> bool

pub fn is_true(&self) -> bool

pub fn is_false(&self) -> bool

pub fn is_nonnull(&self) -> bool

pub fn is_numeric(&self) -> bool

pub fn is_int_or_float(&self) -> bool

pub fn effective_int_or_float(&self) -> Option<bool>

Returns Some(true) if all types are effectively int, Some(false) if all are effectively float, or None if mixed or neither. Handles unions like 1|2 (all int) or 3.4|4.5 (all float).

pub fn is_mixed(&self) -> bool

pub fn is_mixed_template(&self) -> bool

pub fn has_mixed(&self) -> bool

pub fn has_mixed_template(&self) -> bool

pub fn has_nullable_mixed(&self) -> bool

pub fn has_void(&self) -> bool

pub fn has_null(&self) -> bool

pub fn has_nullish(&self) -> bool

pub fn is_nullable_mixed(&self) -> bool

pub fn is_falsy_mixed(&self) -> bool

pub fn is_vanilla_mixed(&self) -> bool

pub fn is_templated_as_vanilla_mixed(&self) -> bool

pub fn has_template_or_static(&self) -> bool

pub fn has_template(&self) -> bool

pub fn has_template_types(&self) -> bool

pub fn get_template_types(&self) -> Vec<&TAtomic>

pub fn is_objecty(&self) -> bool

pub fn is_generator(&self) -> bool

pub fn extends_or_implements( &self, codebase: &CodebaseMetadata, interface: &str, ) -> bool

pub fn is_generic_parameter(&self) -> bool

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

pub fn is_null(&self) -> bool

pub fn is_nullable(&self) -> bool

pub fn is_void(&self) -> bool

pub fn is_voidable(&self) -> bool

pub fn has_resource(&self) -> bool

pub fn is_resource(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_list(&self) -> bool

pub fn is_vanilla_array(&self) -> bool

pub fn is_keyed_array(&self) -> bool

pub fn is_falsable(&self) -> bool

pub fn has_bool(&self) -> bool

pub fn has_scalar(&self) -> bool

Checks if the union explicitly contains the generic scalar type.

This is a specific check for the scalar type itself, not for a combination of types that would form a scalar (e.g., int|string|bool|float). For that, see has_scalar_combination.

pub fn has_scalar_combination(&self) -> bool

Checks if the union contains a combination of types that is equivalent to the generic scalar type (i.e., contains int, float, bool, and string).

pub fn has_array_key(&self) -> bool

pub fn has_iterable(&self) -> bool

pub fn has_array(&self) -> bool

pub fn has_traversable(&self, codebase: &CodebaseMetadata) -> bool

pub fn has_array_key_like(&self) -> bool

pub fn has_numeric(&self) -> bool

pub fn is_always_truthy(&self) -> bool

pub fn is_always_falsy(&self) -> bool

pub fn is_literal_of(&self, other: &TUnion) -> bool

pub fn all_literals(&self) -> bool

pub fn has_static_object(&self) -> bool

pub fn is_static_object(&self) -> bool

pub fn is_single(&self) -> bool

pub fn get_single_string(&self) -> Option<&TString>

pub fn get_single_array(&self) -> Option<&TArray>

pub fn get_single_bool(&self) -> Option<&TBool>

pub fn get_single_named_object(&self) -> Option<&TNamedObject>

pub fn get_single_shaped_object(&self) -> Option<&TObjectWithProperties>

pub fn get_single(&self) -> &TAtomic

pub fn get_single_owned(self) -> TAtomic

pub fn is_named_object(&self) -> bool

pub fn is_enum(&self) -> bool

pub fn is_enum_case(&self) -> bool

pub fn is_single_enum_case(&self) -> bool

pub fn has_named_object(&self) -> bool

pub fn has_object(&self) -> bool

pub fn has_callable(&self) -> bool

pub fn is_callable(&self) -> bool

pub fn has_object_type(&self) -> bool

pub fn get_enum_cases(&self) -> Vec<(Atom, Option<Atom>)>

Return a vector of pairs containing the enum name, and their case name if specified.

pub fn get_single_int(&self) -> Option<TInteger>

pub fn get_single_literal_int_value(&self) -> Option<i64>

pub fn get_single_maximum_int_value(&self) -> Option<i64>

pub fn get_single_minimum_int_value(&self) -> Option<i64>

pub fn get_single_literal_float_value(&self) -> Option<f64>

pub fn get_single_literal_string_value(&self) -> Option<&str>

pub fn get_single_class_string_value(&self) -> Option<Atom>

pub fn get_single_array_key(&self) -> Option<ArrayKey>

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

pub fn get_single_value_of_array_like(&self) -> Option<Cow<'_, TUnion>>

pub fn get_literal_ints(&self) -> Vec<&TAtomic>

pub fn get_literal_strings(&self) -> Vec<&TAtomic>

pub fn get_literal_string_values(&self) -> Vec<Option<Atom>>

pub fn has_literal_float(&self) -> bool

pub fn has_literal_int(&self) -> bool

pub fn has_literal_string(&self) -> bool

pub fn has_literal_value(&self) -> bool

pub fn accepts_false(&self) -> bool

pub fn accepts_null(&self) -> bool

Trait Implementations

impl Clone for TUnion

fn clone(&self) -> TUnion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TUnion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TUnion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a TUnion> for TypeRef<'a>

fn from(reference: &'a TUnion) -> Self

Converts to this type from the input type.

impl Hash for TUnion

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 TUnion

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

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

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

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 TUnion

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

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

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 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 get_pretty_id(&self) -> Atom

impl Eq for TUnion