LSP Types

https://docs.rs/lsp-types/latest/lsp_types/
Admin
LSP Types provides Language Server Protocol types for Rust, based on the official Language Server...
Tokens:955,330
Snippets:12,655
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### From Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceLocation.html?search=u32+-%3E+bool

Demonstrates the usage of the From trait for creating a new type from an existing one.

```rust
fn from(t: T) -> T {
    // Returns the argument unchanged.
    // Source
}
```

--------------------------------

### Vec Push Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.DocumentSelector.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates appending elements to a vector and observing its length and capacity changes. This example also shows how pushing elements might trigger reallocation.

```rust
let mut vec = Vec::with_capacity(10);

// The vector contains no items, even though it has capacity for more
assert_eq!(vec.len(), 0);
assert!(vec.capacity() >= 10);

// These are all done without reallocating...
for i in 0..10 {
    vec.push(i);
}
assert_eq!(vec.len(), 10);
assert!(vec.capacity() >= 10);

// ...but this may make the vector reallocate
vec.push(11);
assert_eq!(vec.len(), 11);
assert!(vec.capacity() >= 11);

// A vector of a zero-sized type will always over-allocate, since no
// allocation is necessary
let vec_units = Vec::<(), System>::with_capacity_in(10, System);
assert_eq!(vec_units.capacity(), usize::MAX);
```

--------------------------------

### TryFrom Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceLocation.html?search=u32+-%3E+bool

Demonstrates the usage of the TryFrom trait for attempting a conversion, which might fail.

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
{
    // Performs the conversion.
    // Source
}
```

--------------------------------

### BorrowMut Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides an example of `borrow_mut`, which allows mutable borrowing of a value.

```rust
fn borrow_mut(&mut self) -> &mut T

```

--------------------------------

### TryFrom Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CodeActionContext.html?search=u32+-%3E+bool

Demonstrates the conversion from another type into CodeActionContext if the source type implements Into<CodeActionContext>.

```rust
type Error = Infallible
```

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

--------------------------------

### Into Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceLocation.html?search=u32+-%3E+bool

Demonstrates the usage of the Into trait for converting one type into another, assuming a From implementation exists.

```rust
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
}
```

--------------------------------

### String::with_capacity() Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.ChangeAnnotationIdentifier.html?search=

Shows how to create a String with a specified initial capacity. This can help reduce reallocations when appending data.

```rust
let mut s = String::with_capacity(10);

// The String contains no chars, even though it has capacity for more
assert_eq!(s.len(), 0);

// These are all done without reallocating...
let cap = s.capacity();
for _ in 0..10 {
    s.push('a');
}

assert_eq!(s.capacity(), cap);

// ...but this may make the string reallocate
s.push('a');
```

--------------------------------

### String::new() Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.ChangeAnnotationIdentifier.html?search=

Demonstrates creating a new, empty String. This method does not allocate an initial buffer.

```rust
let s = String::new();
```

--------------------------------

### TryFrom Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.TraceValue.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates converting from another type into TraceValue. This is part of the standard conversion traits.

```rust
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
{
    type Error = Infallible;
    fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> {
        // ...
    }
}
```

--------------------------------

### TryInto Conversion Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates the usage of the `try_into` method for type conversion, which is available for types implementing `TryFrom`.

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

```

--------------------------------

### JSON String Value Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a JSON string value using the `json!` macro.

```rust
let v = json!("a string");
```

--------------------------------

### Borrow Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Illustrates the `borrow` method for obtaining an immutable reference to a value.

```rust
fn borrow(&self) -> &T

```

--------------------------------

### JSON Array Value Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a JSON array value using the `json!` macro.

```rust
let v = json!(["an", "array"]);
```

--------------------------------

### From Conversion Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates the `from` method, a standard way to create a value of one type from another. This is a fundamental conversion trait.

```rust
fn from(t: T) -> T

```

--------------------------------

### TryFrom Conversion Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Illustrates the `try_from` method for attempting a conversion between types, returning a `Result` to handle potential errors.

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

```

--------------------------------

### Vec::from<&[T]> Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a Vec<T> by cloning elements from a slice.

```rust
assert_eq!(Vec::from(&[1, 2, 3][..]), vec![1, 2, 3]);
```

--------------------------------

### TryInto Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.TraceValue.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates converting TraceValue into another type. This is part of the standard conversion traits.

```rust
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
{
    type Error = <U as TryFrom<T>>::Error;
    fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> {
        // ...
    }
}
```

--------------------------------

### Vec::from<[T; N]> Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a Vec<T> by moving elements from a fixed-size array.

```rust
assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
```

--------------------------------

### JSON Null Value Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a JSON null value using the `json!` macro.

```rust
let v = json!(null);
```

--------------------------------

### Any TypeId Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shows how to get the `TypeId` of a type using the `type_id` method from the `Any` trait.

```rust
fn type_id(&self) -> TypeId

```

--------------------------------

### TextEdit::new Constructor

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.TextEdit.html?search=std%3A%3Avec

Creates a new TextEdit instance with the specified range and new text.

```APIDOC
## impl TextEdit

### pub fn new(range: Range, new_text: String) -> TextEdit

Creates a new TextEdit.
```

--------------------------------

### Insert Element and Get Reference Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates `insert_mut` for inserting an element and obtaining a mutable reference to it. Like `insert`, this is an O(n) operation.

```rust
let mut vec = vec![1, 3, 5, 9];
let x = vec.insert_mut(3, 6);
*x += 1;
assert_eq!(vec, [1, 3, 5, 7, 9]);
```

--------------------------------

### Uri Search Examples

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.Uri.html?search=

Provides examples of how to perform searches related to URIs.

```APIDOC
## Example Searches

### General Search

```
std::vec
```

### Type Conversion Search

```
u32 -> bool
```

### Generic Type Transformation Search

```
Option<T>, (T -> U) -> Option<U>
```
```

--------------------------------

### Initialize Request Details

Source: https://docs.rs/lsp-types/latest/lsp_types/request/enum.Initialize.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Details about the Initialize request, including its method, parameters, and expected result.

```APIDOC
## Initialize Request

### Description
The initialize request is sent as the first request from the client to the server. If the server receives a request or notification before the `initialize` request, it should handle them as follows:
  * For a request, the response should be errored with `code: -32001`. The message can be chosen by the server.
  * Notifications should be dropped.

### Method
`initialize`

### Parameters
This request does not have parameters. The server should respond with `InitializeResult`.

### Result
`InitializeResult`
```

--------------------------------

### Example Search Queries

Source: https://docs.rs/lsp-types/latest/lsp_types/lsif/struct.DefinitionTag.html?search=

Provides example search queries for finding types and functions within the documentation.

```text
std::vec
```

```text
u32 -> bool
```

```text
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Initialize

Source: https://docs.rs/lsp-types/latest/lsp_types/request/index.html

The initialize request is sent as the first request from the client to the server.

```APIDOC
## Initialize

### Description
The initial request sent from the client to the server to establish communication and capabilities. Servers should handle requests or notifications received before this initialization.

### Method
Not specified (typically a request type identifier)

### Endpoint
Not specified (typically a request type identifier)

### Parameters
None explicitly defined in the source.

### Request Example
None provided.

### Response
None explicitly defined in the source.
```

--------------------------------

### Getting a Reference to a JSON Object

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shows how to use `as_object` to get an immutable reference to the `Map` if the `Value` is a JSON object. Returns `None` otherwise.

```rust
let v = json!({ "a": { "nested": true }, "b": ["an", "array"] });

// The length of `{"nested": true}` is 1 entry.
assert_eq!(v["a"].as_object().unwrap().len(), 1);

// The array `["an", "array"]` is not an object.
assert_eq!(v["b"].as_object(), None);
```

--------------------------------

### Getting a Mutable Reference to a JSON Object

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates using `as_object_mut` to get a mutable reference to the `Map` if the `Value` is a JSON object. Returns `None` otherwise.

```rust
let mut v = json!({ "a": { "nested": true } });

v["a"].as_object_mut().unwrap().clear();
assert_eq!(v, json!({ "a": {} }));
```

--------------------------------

### Append an element and get a mutable reference

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Use push_mut to append an element and immediately get a mutable reference to it. This is useful for modifying the newly added element.

```rust
let mut vec = vec![1, 2];
let last = vec.push_mut(3);
assert_eq!(*last, 3);
assert_eq!(vec, [1, 2, 3]);

let last = vec.push_mut(3);
*last += 1;
assert_eq!(vec, [1, 2, 3, 4]);
```

--------------------------------

### Initialize

Source: https://docs.rs/lsp-types/latest/lsp_types/request/index.html?search=std%3A%3Avec

The initialize request is sent as the first request from the client to the server. If the server receives request or notification before the `initialize` request it should act as follows:

```APIDOC
## Initialize

### Description
The initialize request is sent as the first request from the client to the server. If the server receives request or notification before the `initialize` request it should act as follows:

### Method
Not specified

### Endpoint
Not specified
```

--------------------------------

### Accessing JSON Values with `get`

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shows how to access values within a JSON object or array using the `get` method with string or usize indices. Returns `None` if the index is invalid or the type doesn't match.

```rust
let object = json!({ "A": 65, "B": 66, "C": 67 });
assert_eq!(*object.get("A").unwrap(), json!(65));

let array = json!([ "A", "B", "C" ]);
assert_eq!(*array.get(2).unwrap(), json!("C"));

assert_eq!(array.get("A"), None);
```

--------------------------------

### PartialEq Implementation for CreateFileOptions

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CreateFileOptions.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods for comparing CreateFileOptions instances for equality.

```rust
fn eq(&self, other: &CreateFileOptions) -> bool
```

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

--------------------------------

### Create New TextEdit

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.TextEdit.html

Constructor for creating a new TextEdit instance. Requires a Range and the new text content.

```rust
pub fn new(range: Range, new_text: String) -> TextEdit
```

--------------------------------

### T::type_id

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.InlayHint.html?search=u32+-%3E+bool

Gets the `TypeId` of the implementing type.

```APIDOC
## T::type_id

### Description
Gets the `TypeId` of `self`.

### Signature
`fn type_id(&self) -> TypeId`
```

--------------------------------

### Get NonNull Pointer to Vec Buffer (Rust - Nightly)

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=std%3A%3Avec

Use the nightly-only `as_non_null` to get a `NonNull` pointer to the vector's buffer. Similar to `as_mut_ptr`, it allows direct pointer manipulation for initialization. Requires the `box_vec_non_null` feature.

```rust
#![feature(box_vec_non_null)]

// Allocate vector big enough for 4 elements.
let size = 4;
let mut x: Vec<i32> = Vec::with_capacity(size);
let x_ptr = x.as_non_null();

// Initialize elements via raw pointer writes, then set length.
unsafe {
    for i in 0..size {
        x_ptr.add(i).write(i as i32);
    }
    x.set_len(size);
}
assert_eq!(&*x, &[0, 1, 2, 3]);
```

```rust
#![feature(box_vec_non_null)]

unsafe {
    let mut v = vec![0];
    let ptr1 = v.as_non_null();
    ptr1.write(1);
    let ptr2 = v.as_non_null();
    ptr2.write(2);
    // Notably, the write to `ptr2` did *not* invalidate `ptr1`:
    ptr1.write(3);
}
```

--------------------------------

### JSON Number Value Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a JSON number value (integer or floating point) using the `json!` macro.

```rust
let v = json!(12.5);
```

--------------------------------

### WorkspaceFoldersRequest

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html

Request to get the list of workspace folders.

```APIDOC
## workspace/workspaceFolders Request

### Description
Requests the list of workspace folders the client is currently managing.

### Method
POST

### Endpoint
/workspace/workspaceFolders

### Parameters
#### Request Body
- **params** (void) - No parameters are required for this request.

### Response
#### Success Response (200)
- **result** (Option<Vec<WorkspaceFolder>>) - A list of workspace folders or null if none are configured.
```

--------------------------------

### Get Non-Null Pointer to Vec Buffer (Nightly)

Source: https://docs.rs/lsp-types/latest/lsp_types/type.DocumentSelector.html

Use `as_non_null` to get a `NonNull` pointer to the vector's buffer. This nightly-only API is useful for similar pointer-based initialization as `as_mut_ptr`, with the added guarantee of non-nullness. Ensure the vector outlives the pointer.

```rust
#![feature(box_vec_non_null)]

// Allocate vector big enough for 4 elements.
let size = 4;
let mut x: Vec<i32> = Vec::with_capacity(size);
let x_ptr = x.as_non_null();

// Initialize elements via raw pointer writes, then set length.
unsafe {
    for i in 0..size {
        x_ptr.add(i).write(i as i32);
    }
    x.set_len(size);
}
assert_eq!(&*x, &[0, 1, 2, 3]);

// Due to the aliasing guarantee, the following code is legal:
unsafe {
    let mut v = vec![0];
    let ptr1 = v.as_non_null();
    ptr1.write(1);
    let ptr2 = v.as_non_null();
    ptr2.write(2);
    // Notably, the write to `ptr2` did *not* invalidate `ptr1`:
    ptr1.write(3);
}

```

--------------------------------

### Eq and PartialEq Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ConfigurationItem.html?search=std%3A%3Avec

Provides equality comparison for ConfigurationItem instances.

```APIDOC
### impl Eq for ConfigurationItem

### impl PartialEq for ConfigurationItem

#### fn eq(&self, other: &ConfigurationItem) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.

#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.DocumentSymbol.html?search=u32+-%3E+bool

Provides the `type_id` method to get the `TypeId` of an object.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Returns
`TypeId` - The unique identifier for the type of `self`.
```

--------------------------------

### workspace/configuration

Source: https://docs.rs/lsp-types/latest/lsp_types/request/index.html?search=std%3A%3Avec

Fetches configuration settings from the client. The server sends this request to the client to retrieve configuration details. Multiple settings can be fetched in a single request, and the response order matches the request order.

```APIDOC
## workspace/configuration

### Description
Fetches configuration settings from the client. The server sends this request to the client to retrieve configuration details. Multiple settings can be fetched in a single request, and the response order matches the request order.

### Method
POST

### Endpoint
/workspace/configuration

### Parameters
#### Request Body
- **items** (ConfigurationItem[]) - Required - An array of configuration items to fetch.
```

--------------------------------

### WillSaveWaitUntil

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html?search=

Request to get text edits before a document is saved.

```APIDOC
## textDocument/willSaveWaitUntil

### Description
Requests the server to provide text edits that should be applied before a document is saved.

### Method
POST

### Endpoint
/textDocument/willSaveWaitUntil

### Parameters
#### Request Body
- **params** (WillSaveTextDocumentParams) - Required - Parameters for the will save text document request.

### Response
#### Success Response (200)
- **result** (Option<Vec<TextEdit>>) - A list of text edits or null if no edits are needed.
```

--------------------------------

### fn type_id(&self) -> TypeId

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.SymbolInformation.html?search=std%3A%3Avec

Gets the TypeId of the current type.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`. This method is part of the `Any` trait and allows for runtime type identification.
```

--------------------------------

### PartialEq and Eq Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ConfigurationItem.html?search=

Provides methods for comparing ConfigurationItem instances for equality.

```APIDOC
### impl Eq for ConfigurationItem
### impl PartialEq for ConfigurationItem

* `fn eq(&self, other: &ConfigurationItem) -> bool` - Tests for `self` and `other` values to be equal.
* `fn ne(&self, other: &Rhs) -> bool` - Tests for `!=`.
```

--------------------------------

### TypeHierarchySupertypes

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html

Request to get the supertypes of a given type hierarchy item.

```APIDOC
## typeHierarchy/supertypes Request

### Description
Retrieves the direct supertypes of a given type hierarchy item.

### Method
POST

### Endpoint
/typeHierarchy/supertypes

### Parameters
#### Request Body
- **params** (TypeHierarchySupertypesParams) - Required - Parameters specifying the child type hierarchy item.

### Response
#### Success Response (200)
- **result** (Option<Vec<TypeHierarchyItem>>) - A list of supertype hierarchy items or null.
```

--------------------------------

### From and Into Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.HoverParams.html?search=u32+-%3E+bool

Demonstrates the conversion of a type into itself, and the ability to convert into other types that implement From.

```rust
fn from(t: T) -> T
```

```rust
fn into(self) -> U
where U: From<T>
```

--------------------------------

### PartialEq Implementation for ClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ClientCapabilities.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides equality comparison for ClientCapabilities instances.

```APIDOC
### impl PartialEq for ClientCapabilities

#### fn eq(&self, other: &ClientCapabilities) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.

#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### TypeHierarchySubtypes

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html

Request to get the subtypes of a given type hierarchy item.

```APIDOC
## typeHierarchy/subtypes Request

### Description
Retrieves the direct subtypes of a given type hierarchy item.

### Method
POST

### Endpoint
/typeHierarchy/subtypes

### Parameters
#### Request Body
- **params** (TypeHierarchySubtypesParams) - Required - Parameters specifying the parent type hierarchy item.

### Response
#### Success Response (200)
- **result** (Option<Vec<TypeHierarchyItem>>) - A list of subtype hierarchy items or null.
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.Documentation.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides the `type_id` method to get the `TypeId` of a value.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### TryFrom and TryInto Implementations for InlayHintResolveClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.InlayHintResolveClientCapabilities.html

Provides mechanisms for attempting conversions to and from InlayHintResolveClientCapabilities, returning a Result to handle potential errors.

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

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### impl PartialEq for ServerCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ServerCapabilities.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Enables equality comparison for ServerCapabilities.

```APIDOC
## fn eq(&self, other: &ServerCapabilities) -> bool

### Description
Tests for `self` and `other` values to be equal, and is used by `==`.

### Method
`eq`
```

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

### Description
Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.

### Method
`ne`
```

--------------------------------

### InitializeParams

Source: https://docs.rs/lsp-types/latest/lsp_types/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Parameters for the Initialize request.

```APIDOC
## Struct: InitializeParams

### Description
Parameters for the Initialize request.

### Parameters
(No specific parameters documented in the source)
```

--------------------------------

### Get Vector Length with len

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the number of elements currently in the vector.

```Rust
let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);
```

--------------------------------

### FileCreate PartialEq Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.FileCreate.html?search=

Enables equality comparison for FileCreate instances using `eq` and `ne` methods.

```rust
fn eq(&self, other: &FileCreate) -> bool
```

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

--------------------------------

### Any Implementation: type_id

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.LanguageString.html?search=u32+-%3E+bool

Gets the TypeId of the current type. This is part of the Any trait implementation.

```rust
fn type_id(&self) -> TypeId {
    // Implementation details omitted for brevity
}
```

--------------------------------

### PartialEq Implementation for DocumentLinkOptions

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.DocumentLinkOptions.html?search=

Provides methods for comparing DocumentLinkOptions for equality (eq) and inequality (ne).

```rust
fn eq(&self, other: &DocumentLinkOptions) -> bool
```

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

--------------------------------

### Range Constructor

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.Range.html

Creates a new Range with specified start and end positions.

```rust
pub fn new(start: Position, end: Position) -> Range
```

--------------------------------

### InitializeResult

Source: https://docs.rs/lsp-types/latest/lsp_types/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The result of the Initialize request.

```APIDOC
## Struct: InitializeResult

### Description
The result of the Initialize request.

### Parameters
(No specific parameters documented in the source)
```

--------------------------------

### Vec::from<&mut [T]> Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a Vec<T> by cloning elements from a mutable slice.

```rust
assert_eq!(Vec::from(&mut [1, 2, 3][..]), vec![1, 2, 3]);
```

--------------------------------

### PartialEq Implementation for InlayHintServerCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.InlayHintServerCapabilities.html

Provides methods for comparing InlayHintServerCapabilities values for equality.

```rust
fn eq(&self, other: &InlayHintServerCapabilities) -> bool
```

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

--------------------------------

### From<StaticTextDocumentRegistrationOptions> for ImplementationProviderCapability

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.ImplementationProviderCapability.html?search=std%3A%3Avec

Allows creating an `ImplementationProviderCapability::Options` variant from `StaticTextDocumentRegistrationOptions`.

```APIDOC
## From<StaticTextDocumentRegistrationOptions> for ImplementationProviderCapability

### fn from(from: StaticTextDocumentRegistrationOptions) -> Self

Converts a `StaticTextDocumentRegistrationOptions` value into the `ImplementationProviderCapability::Options` variant.
```

--------------------------------

### UnregisterCapability Any Trait Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/request/enum.UnregisterCapability.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Implements the `Any` trait for `UnregisterCapability`, providing a way to get the `TypeId` of the enum.

```rust
impl<T> Any for T
where
    T: 'static + ?Sized,
{
    fn type_id(&self) -> TypeId
}

```

--------------------------------

### fn type_id(&self) -> TypeId

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.OneOf.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the `TypeId` of `self`. This method is part of the `Any` trait implementation.

```APIDOC
#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`. Read more
```

--------------------------------

### TryInto Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.InlineValueServerCapabilities.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates the usage of the `TryInto` trait, which provides a fallible conversion from one type to another. This is often used for conversions that might fail.

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
where U: TryFrom<T>,
```

--------------------------------

### WatchKind Initialization Methods

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WatchKind.html?search=

Methods for creating WatchKind instances. `empty()` creates a WatchKind with no flags set, while `all()` creates one with all flags set.

```rust
pub const fn empty() -> Self
```

```rust
pub const fn all() -> Self
```

--------------------------------

### Eq and PartialEq Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CompletionItemCapabilityResolveSupport.html?search=

Provides methods for comparing CompletionItemCapabilityResolveSupport instances for equality.

```APIDOC
### impl Eq for CompletionItemCapabilityResolveSupport

### impl PartialEq for CompletionItemCapabilityResolveSupport

#### fn eq(&self, other: &CompletionItemCapabilityResolveSupport) -> bool
Tests for `self` and `other` values to be equal.

#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### JSON Boolean Value Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPAny.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a JSON boolean value using the `json!` macro.

```rust
let v = json!(true);
```

--------------------------------

### Initialize Request

Source: https://docs.rs/lsp-types/latest/lsp_types/request/enum.Initialize.html?search=u32+-%3E+bool

The `initialize` request is the first request sent from the client to the server. Servers must handle requests and notifications received before `initialize` appropriately.

```APIDOC
## Initialize Request

### Description
The `initialize` request is sent as the first request from the client to the server. If the server receives a request or notification before the `initialize` request, it should act as follows:
  * For a request, the response should be errored with `code: -32001`. The message can be chosen by the server.
  * Notifications should be dropped.

### Method
This documentation pertains to the `initialize` method within the `lsp_types::request` module.

### Type Information
```rust
pub enum Initialize {}
```

### Associated Constants and Types
This enum implements the `Request` trait, which provides the following:

- `METHOD`: The string identifier for this request, which is `"initialize"`.
- `Params`: The type for the parameters of this request, which is `InitializeParams`.
- `Result`: The type for the result of this request, which is `InitializeResult`.
```

--------------------------------

### Insert Element Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shows how to insert an element at a specific index using `insert`, which shifts subsequent elements to the right. This operation has a time complexity of O(n).

```rust
let mut vec = vec!['a', 'b', 'c'];
vec.insert(1, 'd');
assert_eq!(vec, ['a', 'd', 'b', 'c']);
vec.insert(4, 'e');
assert_eq!(vec, ['a', 'd', 'b', 'c', 'e']);
```

--------------------------------

### Vec::from<&[T; N]> Example

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates creating a Vec<T> by cloning elements from a fixed-size array reference.

```rust
assert_eq!(Vec::from(&[1, 2, 3]), vec![1, 2, 3]);
```

--------------------------------

### PartialEq Implementation for ServerCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ServerCapabilities.html?search=

Defines equality comparison for ServerCapabilities instances.

```APIDOC
## fn eq(&self, other: &ServerCapabilities) -> bool

### Description
Tests for `self` and `other` values to be equal, and is used by `==`.

### Method
`eq`
```

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

### Description
Tests for `!=`.

### Method
`ne`
```

--------------------------------

### Generic DeserializeOwned Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceSymbolResolveSupportCapability.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Highlights the DeserializeOwned trait, which is a bound for types that can be deserialized without a lifetime.

```rust
where T: for<'de> Deserialize<'de>
```

--------------------------------

### PartialEq Implementation for NotebookDocumentSyncRegistrationOptions

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.NotebookDocumentSyncRegistrationOptions.html?search=std%3A%3Avec

Tests for equality between two NotebookDocumentSyncRegistrationOptions instances.

```rust
fn eq(&self, other: &NotebookDocumentSyncRegistrationOptions) -> bool
```

--------------------------------

### Blanket Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.PositionEncodingKind.html?search=

Demonstrates blanket implementations that apply to generic types, including examples relevant to PositionEncodingKind.

```APIDOC
## Blanket Implementations

### impl<T> Any for T

This blanket implementation provides the `type_id` method.

#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T

This blanket implementation provides the `borrow` method.

#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T

This blanket implementation provides the `borrow_mut` method.

#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> CloneToUninit for T

This blanket implementation provides the `clone_to_uninit` method (nightly-only).

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`.

### impl<T> DeserializeOwned for T

This blanket implementation is for types that implement `Deserialize`.

### impl<T> From<T> for T

This blanket implementation provides the `from` method.

#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T

This blanket implementation provides the `into` method.

#### fn into(self) -> U
Calls `U::from(self)`.

### impl<T> ToOwned for T

This blanket implementation provides `Owned` type alias and `to_owned`, `clone_into` methods.

#### type Owned = T
The resulting type after obtaining ownership.

#### fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning.

#### fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning.

### impl<T, U> TryFrom<U> for T

This blanket implementation provides `Error` type alias and `try_from` method.

#### type Error = Infallible
The type returned in the event of a conversion error.

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

### impl<T, U> TryInto<U> for T

This blanket implementation provides `Error` type alias and `try_into` method.

#### type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
```

--------------------------------

### CompletionItemCapability - Debug Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CompletionItemCapability.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Enables formatting CompletionItemCapability instances for debugging purposes.

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

Formats the value using the given formatter.
```

--------------------------------

### CompletionItemCapability - PartialEq and Eq Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CompletionItemCapability.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Enables equality comparisons for CompletionItemCapability instances.

```APIDOC
## fn eq(&self, other: &CompletionItemCapability) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.

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

Tests for `!=`.
```

--------------------------------

### PartialEq Implementation for ClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ClientCapabilities.html?search=u32+-%3E+bool

Allows comparing two ClientCapabilities instances for equality. This is useful for testing or verifying that capabilities match.

```rust
fn eq(&self, other: &ClientCapabilities) -> bool
```

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

--------------------------------

### PartialEq Implementation for CreateFileOptions

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CreateFileOptions.html?search=

Tests for equality between two CreateFileOptions values.

```rust
fn eq(&self, other: &CreateFileOptions) -> bool
```

--------------------------------

### Get Underlying Allocator Reference (Nightly)

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPArray.html

Returns a reference to the underlying allocator. This is a nightly-only experimental API.

```rust
let allocator = vec.allocator();
```

--------------------------------

### Clone Implementation for NotebookDocumentClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.NotebookDocumentClientCapabilities.html

Provides methods for creating a duplicate (`clone`) or performing copy-assignment (`clone_from`) of a NotebookDocumentClientCapabilities instance. The `clone` method is available in stable Rust, while `clone_from` is also available.

```rust
fn clone(&self) -> NotebookDocumentClientCapabilities
```

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

--------------------------------

### Get Immutable Slice of Vec

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Extracts an immutable slice containing all elements of the vector. Equivalent to `&s[..]`.

```Rust
use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();
```

--------------------------------

### PartialEq Implementation for NotebookDocumentSyncClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.NotebookDocumentSyncClientCapabilities.html

Tests for equality between two NotebookDocumentSyncClientCapabilities instances.

```rust
fn eq(&self, other: &NotebookDocumentSyncClientCapabilities) -> bool
```

--------------------------------

### textDocument/prepareRename

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The prepare rename request is sent from the client to the server to get information about a potential rename operation.

```APIDOC
## textDocument/prepareRename

### Description

The prepare rename request is sent from the client to the server to get information about a potential rename operation.

### Method

POST

### Endpoint

textDocument/prepareRename

### Parameters

#### Request Body

- **params** (TextDocumentPositionParams) - Required - The position to prepare the rename for.

### Response

#### Success Response (200)

- **result** (Option<PrepareRenameResponse>) - Information about the rename operation.
```

--------------------------------

### Eq and PartialEq Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.SignatureHelpRegistrationOptions.html?search=std%3A%3Avec

Provides methods for comparing SignatureHelpRegistrationOptions instances for equality.

```APIDOC
### impl Eq for SignatureHelpRegistrationOptions
### impl PartialEq for SignatureHelpRegistrationOptions

#### fn eq(&self, other: &SignatureHelpRegistrationOptions) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.
```

```APIDOC
#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### PartialEq and Eq Implementations for DocumentLinkClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.DocumentLinkClientCapabilities.html?search=

Enables equality comparisons for DocumentLinkClientCapabilities instances.

```rust
fn eq(&self, other: &DocumentLinkClientCapabilities) -> bool
```

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

--------------------------------

### type_id Method for Any Trait

Source: https://docs.rs/lsp-types/latest/lsp_types/request/enum.ExecuteCommand.html?search=

Implementation of the Any trait's type_id method, which gets the TypeId of the current instance.

```rust
fn type_id(&self) -> TypeId;
```

--------------------------------

### PartialEq and Eq Implementations for WorkspaceServerCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceServerCapabilities.html?search=

Enables comparison for equality between two WorkspaceServerCapabilities instances.

```rust
fn eq(&self, other: &WorkspaceServerCapabilities) -> bool
```

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

--------------------------------

### CodeLensResolve type_id Method

Source: https://docs.rs/lsp-types/latest/lsp_types/request/enum.CodeLensResolve.html

Implementation of the type_id method for the Any trait for CodeLensResolve. This method gets the TypeId of the value.

```rust
fn type_id(&self) -> TypeId;

```

--------------------------------

### PartialEq Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ServerInfo.html?search=

Provides methods for comparing ServerInfo instances for equality.

```APIDOC
### impl PartialEq for ServerInfo

#### fn eq(&self, other: &ServerInfo) -> bool
Tests for `self` and `other` values to be equal.
```

```APIDOC
#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### WorkDoneProgressBegin Struct Definition

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkDoneProgressBegin.html

Defines the structure for a WorkDoneProgressBegin notification, used to signal the start of a long-running operation.

```APIDOC
## Struct WorkDoneProgressBegin

### Summary
```rust
pub struct WorkDoneProgressBegin {
    pub title: String,
    pub cancellable: Option<bool>,
    pub message: Option<String>,
    pub percentage: Option<u32>,
}
```

## Fields

### `title: String`
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed. Examples: “Indexing” or “Linking dependencies”.

### `cancellable: Option<bool>`
Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don’t support cancellation are allowed to ignore the setting.

### `message: Option<String>`
Optional, more detailed associated progress message. Contains complementary information to the `title`.
Examples: “3/25 files”, “project/src/module2”, “node_modules/some_dep”. If unset, the previous progress message (if any) is still valid.

### `percentage: Option<u32>`
Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the `percentage` value in subsequent in report notifications.
The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]
```

--------------------------------

### ToOwned Implementation Example

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.WorkspaceLocation.html?search=u32+-%3E+bool

Demonstrates the usage of the ToOwned trait for creating an owned version of data from borrowed data.

```rust
type Owned = T;
// The resulting type after obtaining ownership.
// Source

```

```rust
fn to_owned(&self) -> T {
    // Creates owned data from borrowed data, usually by cloning. Read more
    // Source
}
```

```rust
fn clone_into(&self, target: &mut T) {
    // Uses borrowed data to replace owned data, usually by cloning. Read more
    // Source
}
```

--------------------------------

### PartialEq Implementation

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ServerInfo.html?search=std%3A%3Avec

Provides methods for comparing ServerInfo instances for equality.

```APIDOC
### impl PartialEq for ServerInfo

#### fn eq(&self, other: &ServerInfo) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.
```

```APIDOC
#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### DocumentFilter Examples

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.DocumentFilter.html

Illustrates how to create DocumentFilter instances for specific document types, such as TypeScript files or package.json files.

```json
{ language: ‘typescript’, scheme: ‘file’ }
```

```json
{ language: ‘json’, pattern: ‘**/package.json’ }
```

--------------------------------

### Debug fmt Example

Source: https://docs.rs/lsp-types/latest/lsp_types/notification/enum.DidChangeTextDocument.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates the `fmt` method from the `Debug` trait, used for formatting values for debugging output.

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

```

--------------------------------

### Convert String to InlayHintTooltip

Source: https://docs.rs/lsp-types/latest/lsp_types/enum.InlayHintTooltip.html

Demonstrates converting a String into an InlayHintTooltip. This is useful when the tooltip content is plain text.

```rust
impl From<String> for InlayHintTooltip {
    fn from(from: String) -> Self {
        // ... implementation details ...
    }
}
```

--------------------------------

### PartialEq Implementation for ShowDocumentClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ShowDocumentClientCapabilities.html?search=

Defines equality comparison for ShowDocumentClientCapabilities instances, allowing checks for equality and inequality.

```rust
fn eq(&self, other: &ShowDocumentClientCapabilities) -> bool
```

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

--------------------------------

### Get Map Length

Source: https://docs.rs/lsp-types/latest/lsp_types/type.LSPObject.html

Returns the number of key-value pairs currently stored in the map. This is a simple count of the elements.

```rust
pub fn len(&self) -> usize
```

--------------------------------

### PartialEq Implementation for DocumentLinkClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.DocumentLinkClientCapabilities.html?search=u32+-%3E+bool

Tests for equality between two DocumentLinkClientCapabilities instances.

```rust
fn eq(&self, other: &DocumentLinkClientCapabilities) -> bool
```

--------------------------------

### Get Mutable Slice of Vec

Source: https://docs.rs/lsp-types/latest/lsp_types/type.CodeActionResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Extracts a mutable slice containing all elements of the vector. Equivalent to `&mut s[..]`.

```Rust
use std::io::{self, Read};
let mut buffer = vec![0; 3];
io::repeat(0b101).read_exact(buffer.as_mut_slice()).unwrap();
```

--------------------------------

### Initialize Request

Source: https://docs.rs/lsp-types/latest/lsp_types/request/trait.Request.html?search=std%3A%3Avec

The initialize request is sent from the client to the server to initialize the server.

```APIDOC
## POST initialize

### Description
Initializes the language server.

### Method
POST

### Endpoint
initialize

### Parameters
#### Request Body
- **params** (InitializeParams) - Required - Initialization parameters.

### Response
#### Success Response (200)
- **result** (InitializeResult) - The result of the initialization.
```

--------------------------------

### Get String Length in Bytes

Source: https://docs.rs/lsp-types/latest/lsp_types/type.ChangeAnnotationIdentifier.html?search=

Returns the length of the string in bytes. Note that this may not correspond to the number of characters.

```Rust
let a = String::from("foo");
assert_eq!(a.len(), 3);

let fancy_f = String::from("ƒoo");
assert_eq!(fancy_f.len(), 4);
assert_eq!(fancy_f.chars().count(), 3);
```

--------------------------------

### String Conversion from Other Types

Source: https://docs.rs/lsp-types/latest/lsp_types/type.ChangeAnnotationIdentifier.html?search=

Demonstrates how to convert various types into a String, including string slices, boxed strings, and character literals.

```APIDOC
## fn from(s: &String) -> String

### Description
Converts a `&String` into a `String` by cloning the original string.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## fn from(s: &mut str) -> String

### Description
Converts a mutable string slice `&mut str` into an owned `String`. The result is allocated on the heap.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## fn from(s: &str) -> String

### Description
Converts a string slice `&str` into an owned `String`. The result is allocated on the heap.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## fn from(s: Box<str>) -> String

### Description
Converts the given boxed `str` slice to a `String`. The `str` slice is owned.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let s1: String = String::from("hello world");
let s2: Box<str> = s1.into_boxed_str();
let s3: String = String::from(s2);

assert_eq!("hello world", s3)
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## fn from(s: Cow<'a, str>) -> String

### Description
Converts a clone-on-write string (`Cow<'a, str>`) to an owned instance of `String`. This extracts the owned string, cloning it if it is not already owned.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
// If the string is not owned...
let cow: Cow<'_, str> = Cow::Borrowed("eggplant");
// It will allocate on the heap and copy the string.
let owned: String = String::from(cow);
assert_eq!(&owned[..], "eggplant");
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

```APIDOC
## fn from(c: char) -> String

### Description
Allocates an owned `String` from a single character.

### Method
`from`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let c: char = 'a';
let s: String = String::from(c);
assert_eq!("a", &s[..]);
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get String Capacity

Source: https://docs.rs/lsp-types/latest/lsp_types/type.ChangeAnnotationIdentifier.html?search=

The `capacity` method returns the total number of bytes the string can hold without reallocating.

```rust
let s = String::with_capacity(10);

assert!(s.capacity() >= 10);
```

--------------------------------

### PartialEq Implementation for ShowDocumentClientCapabilities

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.ShowDocumentClientCapabilities.html

Tests for equality between two ShowDocumentClientCapabilities values.

```rust
fn eq(&self, other: &ShowDocumentClientCapabilities) -> bool
```

--------------------------------

### CodeActionKind::as_str method

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.CodeActionKind.html

Converts a CodeActionKind to its string representation. Use this to get the literal string value of a kind.

```rust
pub fn as_str(&self) -> &str
```

--------------------------------

### Default SignatureInformationSettings

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.SignatureInformationSettings.html

Provides a default instance of SignatureInformationSettings. This is useful when no specific configuration is required, or as a starting point for customization.

```rust
fn default() -> SignatureInformationSettings
```

--------------------------------

### Eq and PartialEq Implementations

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.SignatureInformationSettings.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides methods for comparing SignatureInformationSettings instances for equality.

```APIDOC
### impl Eq for SignatureInformationSettings
### impl PartialEq for SignatureInformationSettings

#### fn eq(&self, other: &SignatureInformationSettings) -> bool
Tests for `self` and `other` values to be equal, and is used by `==`.
```

```APIDOC
#### fn ne(&self, other: &Rhs) -> bool
Tests for `!=`.
```

--------------------------------

### FoldingRange Struct

Source: https://docs.rs/lsp-types/latest/lsp_types/struct.FoldingRange.html?search=std%3A%3Avec

Represents a folding range in code, including start and end positions, kind, and collapsed text.

```APIDOC
## Struct FoldingRange

Represents a folding range.

### Fields
* `start_line` (u32) - The zero-based line number from where the folded range starts.
* `start_character` (Option<u32>) - The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
* `end_line` (u32) - The zero-based line number where the folded range ends.
* `end_character` (Option<u32>) - The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
* `kind` (Option<FoldingRangeKind>) - Describes the kind of the folding range such as `comment’ or ‘region’. The kind is used to categorize folding ranges and used by commands like ‘Fold all comments’. See FoldingRangeKind for an enumeration of standardized kinds.
* `collapsed_text` (Option<String>) - The text that the client should show when the specified range is collapsed. If not defined or not supported by the client, a default will be chosen by the client. @since 3.17.0
```
Tokens:
Raw