mago-reflection 0.26.1

Offers data structures and APIs to represent and inspect PHP code elements—like classes, functions, and interfaces—enabling introspection and analysis.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use serde::Deserialize;
use serde::Serialize;

use mago_source::HasSource;
use mago_source::SourceIdentifier;
use mago_span::HasSpan;
use mago_span::Span;

use crate::r#type::TypeReflection;

/// Represents the return type information for a function-like entity,
/// including the type itself and its location in the source code.
///
/// This structure provides metadata about the return type of a function or method,
/// allowing for introspection and reflection of its type and position.
#[derive(Debug, Clone, Eq, PartialEq, Hash, Serialize, Deserialize, PartialOrd, Ord)]
pub struct FunctionLikeReturnTypeReflection {
    /// The return type of the function-like entity.
    pub type_reflection: TypeReflection,

    /// The location in the source code where the return type is specified.
    pub span: Span,
}

impl HasSpan for FunctionLikeReturnTypeReflection {
    /// Returns the span of the return type in the source code.
    fn span(&self) -> Span {
        self.span
    }
}

impl HasSource for FunctionLikeReturnTypeReflection {
    /// Returns the source identifier of the file containing this return type.
    fn source(&self) -> SourceIdentifier {
        self.span.source()
    }
}