Enum FileType 

#[repr(u8)]
pub enum FileType {
    Host = 0,
    Vendored = 1,
    Builtin = 2,
    Patch = 3,
    External = 4,
}

Distinguishes between the origins of source files.

Variants

Host = 0

The file is part of the primary project source code. These files typically reside on the filesystem and are actively developed.

Vendored = 1

The file belongs to a third-party dependency (e.g., a Composer package). These files exist on the filesystem within the project (e.g., in vendor/) but are not considered part of the primary source code.

Builtin = 2

The file represents a built-in language construct (e.g., a core PHP function or class). These “files” do not exist on the filesystem and their content is typically provided as pre-defined stubs for analysis.

Patch = 3

The file is a user-provided patch that overrides type information for vendored or built-in code with corrected PHPDoc / type declarations. Like vendored files, patches are not actively analyzed, linted, or formatted, but their metadata takes precedence over both vendored and built-in definitions.

External = 4

An in-memory source contributed by an external analyzer plugin during initialization. External files are scanned for symbols, but are never analyzed, linted, formatted, or fixed.

Implementations

impl FileType

pub const fn is_host(self) -> bool

Returns true if the file is a host file, meaning it is part of the project’s source code.

pub const fn is_vendored(self) -> bool

Returns true if the file is a vendored file, meaning it comes from an external library or dependency.

pub const fn is_builtin(self) -> bool

Returns true if the file is a built-in file, meaning it represents a core language construct.

pub const fn is_patch(self) -> bool

Returns true if the file is a patch, meaning it overrides type information for vendored or built-in code.

pub const fn is_external(self) -> bool

Returns true if the file is an in-memory source contributed by an external analyzer plugin.

Trait Implementations

impl Clone for FileType

fn clone(&self) -> FileType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileType

impl Debug for FileType

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

Formats the value using the given formatter.

impl Eq for FileType

impl Hash for FileType

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 FileType

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

fn eq(&self, other: &FileType) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FileType

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