proc_macro::Diagnostic - Rust
Description: API documentation for the Rust `Diagnostic` struct in crate `proc_macro`.
Keywords: rust, rustlang, rust-lang, Diagnostic

# [−][src]Struct proc_macro::Diagnostic

    pub struct Diagnostic { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

A structure representing a diagnostic message and associated children messages.

## Methods

###

`impl Diagnostic`

[src]

####

`pub fn new<T: Into<String>>(level: Level, message: T) -> Diagnostic`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Create a new diagnostic with the given `level` and `message`.

####

`pub fn spanned<S, T>(spans: S, level: Level, message: T) -> Diagnostic where S: MultiSpan, T: Into<String>,`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Create a new diagnostic with the given `level` and `message` pointing to the given set of `spans`.

####

`pub fn span_error<S, T>(self, spans: S, message: T) -> Diagnostic where S: MultiSpan, T: Into<String>,`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `spans` and `message`.

####

`pub fn error<T: Into<String>>(self, message: T) -> Diagnostic`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `message`.

####

`pub fn span_warning<S, T>(self, spans: S, message: T) -> Diagnostic where S: MultiSpan, T: Into<String>,`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `spans` and `message`.

####

`pub fn warning<T: Into<String>>(self, message: T) -> Diagnostic`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `message`.

####

`pub fn span_note<S, T>(self, spans: S, message: T) -> Diagnostic where S: MultiSpan, T: Into<String>,`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `spans` and `message`.

####

`pub fn note<T: Into<String>>(self, message: T) -> Diagnostic`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `message`.

####

`pub fn span_help<S, T>(self, spans: S, message: T) -> Diagnostic where S: MultiSpan, T: Into<String>,`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `spans` and `message`.

####

`pub fn help<T: Into<String>>(self, message: T) -> Diagnostic`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Add a new child diagnostic message to `self` with the level identified by this method's name with the given `message`.

####

`pub fn level(&self) -> Level`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Returns the diagnostic `level` for `self`.

####

`pub fn set_level(&mut self, level: Level)`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Sets the level in `self` to `level`.

####

`pub fn message(&self) -> &str`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Returns the message in `self`.

####

`pub fn set_message<T: Into<String>>(&mut self, message: T)`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Sets the message in `self` to `message`.

####

`pub fn spans(&self) -> &[Span]`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Returns the `Span`s in `self`.

####

`pub fn set_spans<S: MultiSpan>(&mut self, spans: S)`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Sets the `Span`s in `self` to `spans`.

####

`pub fn children(&self) -> Children`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Returns an iterator over the children diagnostics of `self`.

####

`pub fn emit(self)`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_diagnostic` #54140)

Emit the diagnostic.

## Trait Implementations

###

`impl Clone for Diagnostic`

[src]

####

`fn clone(&self) -> Diagnostic`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl Debug for Diagnostic`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl !Send for Diagnostic`

###

`impl !Sync for Diagnostic`

## Blanket Implementations

###

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

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

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

####

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

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)