mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
45 lines
1.6 KiB
Swift
45 lines
1.6 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// Request from the client to the server asking for contents of a URI having a custom scheme **(LSP Extension)**
|
|
/// For example: "sourcekit-lsp:"
|
|
///
|
|
/// - Parameters:
|
|
/// - uri: The `DocumentUri` of the custom scheme url for which content is required
|
|
///
|
|
/// - Returns: `GetReferenceDocumentResponse` which contains the `content` to be displayed.
|
|
///
|
|
/// ### LSP Extension
|
|
///
|
|
/// This request is an extension to LSP supported by SourceKit-LSP.
|
|
/// Enable the experimental client capability `"workspace/getReferenceDocument"` so that the server responds with
|
|
/// reference document URLs for certain requests or commands whenever possible.
|
|
public struct GetReferenceDocumentRequest: RequestType {
|
|
public static let method: String = "workspace/getReferenceDocument"
|
|
public typealias Response = GetReferenceDocumentResponse
|
|
|
|
public var uri: DocumentURI
|
|
|
|
public init(uri: DocumentURI) {
|
|
self.uri = uri
|
|
}
|
|
}
|
|
|
|
/// Response containing `content` of `GetReferenceDocumentRequest`
|
|
public struct GetReferenceDocumentResponse: ResponseType {
|
|
public var content: String
|
|
|
|
public init(content: String) {
|
|
self.content = content
|
|
}
|
|
}
|