Struct Ident 

pub struct Ident<'src>(/* private fields */);

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

Memory layout is identical to &'src str (16 bytes); Option<Ident> is also 16 bytes via the standard pointer niche. The “error” state — produced during error recovery when no identifier was found in the source — is represented by an empty string slice, which cannot occur for a real PHP identifier (the lexer rejects empty matches).

Use Ident::name / Ident::ERROR to construct, Ident::as_str to extract a real name, Ident::is_error to test for the error state. Serialises as a JSON string for real names and null for the error state.

Implementations

impl<'src> Ident<'src>

pub const ERROR: Self

Sentinel for “no identifier was parsed” — same memory layout as a real Ident, distinguished by the empty-string interior.

pub fn name(s: &'src str) -> Self

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

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) -> Ident<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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<'src> Serialize for Ident<'src>

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

Serialize this value into the given Serde serializer.

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