Struct DiagnosticDisplay 

pub struct DiagnosticDisplay<T>(pub T);

Available on crate feature unstable-wgpu-27 only.

A wrapper for displaying Naga IR terms in diagnostic output.

For some Naga IR type T, DiagnosticDisplay<T> implements core::fmt::Display in a way that displays values of type T appropriately for diagnostic messages presented to human readers.

For example, the implementation of Display for DiagnosticDisplay<Scalar> formats the type represented by the given Scalar appropriately for users.

Some types like Handle<Type> require contextual information like a type arena to be displayed. In such cases, we implement Display for a type like DiagnosticDisplay<(Handle<Type>, GlobalCtx)>, where the GlobalCtx type provides the necessary context.

Do not implement this type for TypeInner, as that does not have enough information to display struct types correctly.

If you only need debugging output, DiagnosticDebug uses easier-to-obtain context types but still does a good enough job for logging or debugging.

Language-sensitive diagnostics

Diagnostic output ought to depend on the source language from which the IR was produced: diagnostics resulting from processing GLSL code should use GLSL type syntax, for example. That means that DiagnosticDisplay ought to include some indication of which notation to use.

For the moment, only WGSL output is implemented, so DiagnosticDisplay lacks any support for this (#7268). However, the plan is that all language-independent code in Naga should use DiagnosticDisplay wherever appropriate, such that when its definition is expanded to include some indication of the right source language to use, any use site that does not supply this indication will provoke a compile-time error.

Tuple Fields

0: T

Trait Implementations

impl Display for DiagnosticDisplay<(&TypeResolution, GlobalCtx<'_>)>

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

Formats the value using the given formatter.

impl Display for DiagnosticDisplay<(&str, &Rule, GlobalCtx<'_>)>

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

Formats the value using the given formatter.

impl Display for DiagnosticDisplay<(Handle<Type>, GlobalCtx<'_>)>

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

Formats the value using the given formatter.

impl Display for DiagnosticDisplay<Scalar>

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

Formats the value using the given formatter.