Enum TypeCheckingFormat 

pub enum TypeCheckingFormat {
    Full,
    Concise,
    Azure,
    Json,
    JsonLines,
    Rdjson,
    Pylint,
    Gitlab,
    Github,
}

How type-check diagnostics are rendered into text.

Mirrors ty’s DiagnosticFormat. Rendering happens wherever the type checker runs (inside the worker for pool sessions), because ty’s structured diagnostics borrow the salsa database and cannot cross a process boundary — so the format has to be chosen before the check, not after it.

Serialized into session dumps by discriminant, so new variants must be appended — inserting one shifts every later variant and silently rewrites older dumps’ format (see DUMP_VERSION in monty).

Variants

Full

Human-readable diagnostics with a source snippet and carets.

Concise

One path:line:col: severity[rule] message line per diagnostic.

Azure

Azure Pipelines logging commands.

Json

A JSON array of diagnostic objects.

JsonLines

One JSON diagnostic object per line.

Rdjson

Reviewdog diagnostic JSON.

Pylint

Pylint-compatible output.

Gitlab

GitLab Code Quality report JSON.

Github

GitHub Actions workflow commands.

Implementations

impl TypeCheckingFormat

pub fn from_name(name: &str) -> Result<Self, String>

Parses a format name, reporting the valid names on failure.

Bindings take the format as a string, so the error has to be good enough to show a user who guessed wrong.

pub fn names() -> String

Comma-separated list of the accepted format names.

Trait Implementations

impl Clone for TypeCheckingFormat

fn clone(&self) -> TypeCheckingFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TypeCheckingFormat

impl Debug for TypeCheckingFormat

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

Formats the value using the given formatter.

impl Default for TypeCheckingFormat

fn default() -> TypeCheckingFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TypeCheckingFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TypeCheckingFormat

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

Formats the value using the given formatter.

impl Eq for TypeCheckingFormat

impl FromStr for TypeCheckingFormat

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TypeCheckingFormat, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for TypeCheckingFormat

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TypeCheckingFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TypeCheckingFormat

impl TryFrom<&str> for TypeCheckingFormat

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<TypeCheckingFormat, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantNames for TypeCheckingFormat

const VARIANTS: &'static [&'static str]

Names of the variants of this enum