Struct InitializeRequest 

pub struct InitializeRequest {
    pub workspace_root: String,
    pub index_on_open: Option<bool>,
    pub db_path: Option<String>,
    pub detect_names: Option<bool>,
    pub dictionaries_bundled: Option<bool>,
    pub dictionaries_disabled: Vec<String>,
    pub dictionaries_paths: Vec<String>,
}

Fields

workspace_root: String

index_on_open: Option<bool>

VS Code global setting: whether to index the whole workspace on open. The server uses this as a fallback when .languagecheck.yaml doesn’t set workspace.index_on_open.

db_path: Option<String>

Custom path for the workspace database file. When empty, the server stores databases in the user data directory (~/.local/share/language-check/dbs/).

detect_names: Option<bool>

VS Code global setting: whether to suppress spelling diagnostics on tokens detected as human names. Used as a fallback when .languagecheck.yaml doesn’t set names.enabled.

dictionaries_bundled: Option<bool>

VS Code global setting: whether to load the bundled domain-specific dictionaries. Used as a fallback when .languagecheck.yaml doesn’t set dictionaries.bundled.

dictionaries_disabled: Vec<String>

VS Code global setting: names of individual bundled dictionaries to skip. Used as a fallback when .languagecheck.yaml doesn’t set dictionaries.disabled.

dictionaries_paths: Vec<String>

VS Code global setting: additional wordlist files to load. Used as a fallback when .languagecheck.yaml doesn’t set dictionaries.paths.

Implementations

impl InitializeRequest

pub fn index_on_open(&self) -> bool

Returns the value of index_on_open, or the default value if index_on_open is unset.

pub fn db_path(&self) -> &str

Returns the value of db_path, or the default value if db_path is unset.

pub fn detect_names(&self) -> bool

Returns the value of detect_names, or the default value if detect_names is unset.

pub fn dictionaries_bundled(&self) -> bool

Returns the value of dictionaries_bundled, or the default value if dictionaries_bundled is unset.

Trait Implementations

impl Clone for InitializeRequest

fn clone(&self) -> InitializeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitializeRequest

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

Formats the value using the given formatter.

impl Default for InitializeRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InitializeRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InitializeRequest

impl Hash for InitializeRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for InitializeRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for InitializeRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InitializeRequest

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 InitializeRequest