Skip to main content

WriteResult

Struct WriteResult 

Source
pub struct WriteResult {
    pub syntax_valid: Option<bool>,
    pub formatted: bool,
    pub format_skipped_reason: Option<String>,
    pub validate_requested: bool,
    pub validation_errors: Vec<ValidationError>,
    pub validate_skipped_reason: Option<String>,
    pub lsp_diagnostics: Vec<StoredDiagnostic>,
}
Expand description

Result of the write → format → validate pipeline.

Returned by write_format_validate to give callers a single struct with all post-write signals for the response JSON.

Fields§

§syntax_valid: Option<bool>

Whether tree-sitter syntax validation passed. None if unsupported language.

§formatted: bool

Whether the file was auto-formatted.

§format_skipped_reason: Option<String>

Why formatting was skipped, if it was. Values: “not_found”, “timeout”, “error”, “unsupported_language”.

§validate_requested: bool

Whether full validation was requested (controls whether validation_errors is included in response).

§validation_errors: Vec<ValidationError>

Structured type-checker errors (only populated when validate:“full” is requested).

§validate_skipped_reason: Option<String>

Why validation was skipped, if it was. Values: “not_found”, “timeout”, “error”, “unsupported_language”.

§lsp_diagnostics: Vec<StoredDiagnostic>

LSP diagnostics for the edited file. Only populated when diagnostics: true is passed in the edit request AND a language server is available.

Implementations§

Source§

impl WriteResult

Source

pub fn append_lsp_diagnostics_to(&self, result: &mut Value)

Append LSP diagnostics to a response JSON object. Only adds the field when diagnostics were requested and collected.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

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

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.