Skip to main content

StderrExcerpt

Struct StderrExcerpt 

Source
pub struct StderrExcerpt { /* private fields */ }
Expand description

What a failed server startup wrote to stderr, bounded and sanitized.

Holds the first and last bytes of the output (or all of it when short), so both the opening banner and the final error survive.

§Sanitizing

Control characters other than newline and tab are dropped, as are characters that forge or reorder text in logs and terminals: the Unicode line and paragraph separators, bidirectional controls and zero-width characters.

§Redaction

Values that look secret are replaced with [redacted:NAME] before the text leaves mcpls. A value counts as secret (and must be at least 8 bytes) when it is:

  • an environment variable value, from the server’s configured env or mcpls’s own environment, whose name contains TOKEN, KEY, SECRET, PASSW, CRED or AUTH (case-insensitive);
  • the value of a --flag=value or --flag value argument whose flag name matches the same patterns;
  • a string under a matching key of initialization_options.

Other values, such as RUSTUP_TOOLCHAIN, stay visible so the cause of a failure can still be read. Matching is by exact value: encoded forms (URL, base64, JSON-escaped) are not found. A secret cut by the head/tail elision is hidden only for the fragment of at least 4 bytes on either side of the cut. Put secrets in a name-matching env entry rather than in other places.

Display renders one line: trimmed non-empty lines joined with |, with ... between head and tail when elided. The raw multi-line text is available through Self::head and Self::tail.

§Examples

use mcpls_core::Error;
use mcpls_core::error::InitPhase;

fn server_output(err: &Error) -> Option<String> {
    match err {
        Error::LspInitFailed { stderr: Some(stderr), .. }
        | Error::ServerExitedDuringInit { stderr: Some(stderr), .. } => {
            Some(stderr.to_string())
        }
        _ => None,
    }
}

let err = Error::LspInitFailed {
    phase: InitPhase::Initialize,
    cause: Box::new(Error::ServerTerminated),
    hint: None,
    stderr: None,
};
assert_eq!(server_output(&err), None);

Implementations§

Source§

impl StderrExcerpt

Source

pub fn head(&self) -> &str

The start of the output, or all of it when nothing was dropped.

Source

pub fn tail(&self) -> Option<&str>

The end of the output, present only when the middle was dropped.

Source

pub const fn is_elided(&self) -> bool

Whether the middle of the output was dropped.

Trait Implementations§

Source§

impl Clone for StderrExcerpt

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 StderrExcerpt

Source§

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

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

impl Display for StderrExcerpt

Source§

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

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

impl Eq for StderrExcerpt

Source§

impl PartialEq for StderrExcerpt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StderrExcerpt

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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