Struct Ident 

pub struct Ident<'src> {
    pub span: Span,
    /* private fields */
}

A bare identifier — the kind that names a function, class, parameter, enum case, etc. Distinct from Name, which represents possibly-qualified names.

The “error” state — produced during error recovery when no identifier was found in the source — is represented by an empty name, which cannot occur for a real PHP identifier (the lexer rejects empty matches).

Use Ident::new / Ident::error to construct, Ident::as_str to extract a real name, Ident::is_error to test for the error state. Serialises as {"name": .., "span": ..} for real names and null for the error state.

Fields

span: Span

Source range of the identifier token; includes the $ of a variable name.

Implementations

impl<'src> Ident<'src>

pub fn new(name: &'src str, span: Span) -> Self

Construct an identifier from a non-empty name. Empty input is rejected in debug builds — use Ident::error instead.

pub const fn error(span: Span) -> Self

Placeholder for “no identifier was parsed” at span.

pub fn as_str(&self) -> Option<&'src str>

Returns Some(s) for a real identifier, None for the error state.

pub fn is_error(&self) -> bool

Returns true if this identifier was synthesised during error recovery.

pub fn or_error(&self) -> &'src str

Returns the inner string, or "<error>" for the error state. Useful when constructing diagnostic messages.

Trait Implementations

impl<'src> Clone for Ident<'src>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Copy for Ident<'src>

impl<'src> Debug for Ident<'src>

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

Formats the value using the given formatter.

impl<'src> Display for Ident<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq<&str> for Ident<'src>

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

Equality operator ==.

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

Inequality operator !=.

impl<'src> Serialize for Ident<'src>

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.