Skip to main content

MacroExpansion

Struct MacroExpansion 

Source
pub struct MacroExpansion {
    pub text: String,
    /* private fields */
}
Expand description

Outcome of expand_macros: the expanded text, plus the fault that made it wrong if one did.

Three faults reach here — a name with no definition, a name that resolves into itself, and a reference whose closing delimiter never matched its opener — and they are C’s single entry->error (macCore.c:216-224) split by cause. All three lists are therefore private, and the only way to read them is Self::fault, or Self::errored for the same answer as a bool. A consumer able to reach one list directly hard-fails on the fault it named and returns the other one’s broken text as success; that is not hypothetical, it is what the autosave .req reader did for as long as undefined was pub.

Fields§

§text: String

Implementations§

Source§

impl MacroExpansion

Source

pub fn fault(&self) -> Option<MacroFault<'_>>

The single owner of “did this expansion come out wrong, and why”. Every arm is read here so that no caller can read only some of them.

A macro is never in more than one list: recursive is recorded only where the name resolved to a table entry, undefined only where it resolved to nothing, unterminated only where no name was ever parsed. So the order below decides nothing but which of several independent faults a string carrying more than one reports first.

Source

pub fn errored(&self) -> bool

C MAC_ENTRY.error: whether the expansion came out wrong, by any of the arms that set it. macExpandString returns a negative length for all of them alike (macCore.c:216-224), and that negative length is the whole of what the .db reader’s per-line warning and macDefExpand’s NULL are looking at. Delegates to Self::fault so the bool and the name can never disagree.

Trait Implementations§

Source§

impl Clone for MacroExpansion

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MacroExpansion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MacroExpansion

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more