1//! The Zed Rust Extension API allows you write extensions for [Zed](https://zed.dev/) in Rust.
2
3pub mod http_client;
4pub mod process;
5pub mod settings;
6
7use core::fmt;
8
9use wit::*;
10
11pub use serde_json;
12
13// WIT re-exports.
14//
15// We explicitly enumerate the symbols we want to re-export, as there are some
16// that we may want to shadow to provide a cleaner Rust API.
17pub use wit::{
18 CodeLabel, CodeLabelSpan, CodeLabelSpanLiteral, Command, DownloadedFileType, EnvVars,
19 KeyValueStore, LanguageServerInstallationStatus, Project, Range, Worktree, download_file,
20 make_file_executable,
21 zed::extension::context_server::ContextServerConfiguration,
22 zed::extension::dap::{
23 AttachRequest, BuildTaskDefinition, BuildTaskDefinitionTemplatePayload, BuildTaskTemplate,
24 DebugAdapterBinary, DebugConfig, DebugRequest, DebugScenario, DebugTaskDefinition,
25 LaunchRequest, StartDebuggingRequestArguments, StartDebuggingRequestArgumentsRequest,
26 TaskTemplate, TcpArguments, TcpArgumentsTemplate, resolve_tcp_template,
27 },
28 zed::extension::github::{
29 GithubRelease, GithubReleaseAsset, GithubReleaseOptions, github_release_by_tag_name,
30 latest_github_release,
31 },
32 zed::extension::llm_provider::{
33 CacheConfiguration as LlmCacheConfiguration, CompletionEvent as LlmCompletionEvent,
34 CompletionRequest as LlmCompletionRequest, CredentialType as LlmCredentialType,
35 ImageData as LlmImageData, MessageContent as LlmMessageContent,
36 MessageRole as LlmMessageRole, ModelCapabilities as LlmModelCapabilities,
37 ModelInfo as LlmModelInfo, OauthHttpRequest as LlmOauthHttpRequest,
38 OauthHttpResponse as LlmOauthHttpResponse, OauthWebAuthConfig as LlmOauthWebAuthConfig,
39 OauthWebAuthResult as LlmOauthWebAuthResult, ProviderInfo as LlmProviderInfo,
40 RequestMessage as LlmRequestMessage, StopReason as LlmStopReason,
41 ThinkingContent as LlmThinkingContent, TokenUsage as LlmTokenUsage,
42 ToolChoice as LlmToolChoice, ToolDefinition as LlmToolDefinition,
43 ToolInputFormat as LlmToolInputFormat, ToolResult as LlmToolResult,
44 ToolResultContent as LlmToolResultContent, ToolUse as LlmToolUse,
45 ToolUseJsonParseError as LlmToolUseJsonParseError,
46 delete_credential as llm_delete_credential, get_credential as llm_get_credential,
47 get_env_var as llm_get_env_var, oauth_open_browser as llm_oauth_open_browser,
48 oauth_send_http_request as llm_oauth_send_http_request,
49 oauth_start_web_auth as llm_oauth_start_web_auth,
50 request_credential as llm_request_credential, store_credential as llm_store_credential,
51 },
52 zed::extension::nodejs::{
53 node_binary_path, npm_install_package, npm_package_installed_version,
54 npm_package_latest_version,
55 },
56 zed::extension::platform::{Architecture, Os, current_platform},
57 zed::extension::slash_command::{
58 SlashCommand, SlashCommandArgumentCompletion, SlashCommandOutput, SlashCommandOutputSection,
59 },
60};
61
62// Undocumented WIT re-exports.
63//
64// These are symbols that need to be public for the purposes of implementing
65// the extension host, but aren't relevant to extension authors.
66#[doc(hidden)]
67pub use wit::Guest;
68
69/// Constructs for interacting with language servers over the
70/// Language Server Protocol (LSP).
71pub mod lsp {
72 pub use crate::wit::zed::extension::lsp::{
73 Completion, CompletionKind, InsertTextFormat, Symbol, SymbolKind,
74 };
75}
76
77/// A result returned from a Zed extension.
78pub type Result<T, E = String> = core::result::Result<T, E>;
79
80/// Updates the installation status for the given language server.
81pub fn set_language_server_installation_status(
82 language_server_id: &LanguageServerId,
83 status: &LanguageServerInstallationStatus,
84) {
85 wit::set_language_server_installation_status(&language_server_id.0, status)
86}
87
88/// A Zed extension.
89pub trait Extension: Send + Sync {
90 /// Returns a new instance of the extension.
91 fn new() -> Self
92 where
93 Self: Sized;
94
95 /// Returns the command used to start the language server for the specified
96 /// language.
97 fn language_server_command(
98 &mut self,
99 _language_server_id: &LanguageServerId,
100 _worktree: &Worktree,
101 ) -> Result<Command> {
102 Err("`language_server_command` not implemented".to_string())
103 }
104
105 /// Returns the initialization options to pass to the specified language server.
106 fn language_server_initialization_options(
107 &mut self,
108 _language_server_id: &LanguageServerId,
109 _worktree: &Worktree,
110 ) -> Result<Option<serde_json::Value>> {
111 Ok(None)
112 }
113
114 /// Returns the workspace configuration options to pass to the language server.
115 fn language_server_workspace_configuration(
116 &mut self,
117 _language_server_id: &LanguageServerId,
118 _worktree: &Worktree,
119 ) -> Result<Option<serde_json::Value>> {
120 Ok(None)
121 }
122
123 /// Returns the initialization options to pass to the other language server.
124 fn language_server_additional_initialization_options(
125 &mut self,
126 _language_server_id: &LanguageServerId,
127 _target_language_server_id: &LanguageServerId,
128 _worktree: &Worktree,
129 ) -> Result<Option<serde_json::Value>> {
130 Ok(None)
131 }
132
133 /// Returns the workspace configuration options to pass to the other language server.
134 fn language_server_additional_workspace_configuration(
135 &mut self,
136 _language_server_id: &LanguageServerId,
137 _target_language_server_id: &LanguageServerId,
138 _worktree: &Worktree,
139 ) -> Result<Option<serde_json::Value>> {
140 Ok(None)
141 }
142
143 /// Returns the label for the given completion.
144 fn label_for_completion(
145 &self,
146 _language_server_id: &LanguageServerId,
147 _completion: Completion,
148 ) -> Option<CodeLabel> {
149 None
150 }
151
152 /// Returns the label for the given symbol.
153 fn label_for_symbol(
154 &self,
155 _language_server_id: &LanguageServerId,
156 _symbol: Symbol,
157 ) -> Option<CodeLabel> {
158 None
159 }
160
161 /// Returns the completions that should be shown when completing the provided slash command with the given query.
162 fn complete_slash_command_argument(
163 &self,
164 _command: SlashCommand,
165 _args: Vec<String>,
166 ) -> Result<Vec<SlashCommandArgumentCompletion>, String> {
167 Ok(Vec::new())
168 }
169
170 /// Returns the output from running the provided slash command.
171 fn run_slash_command(
172 &self,
173 _command: SlashCommand,
174 _args: Vec<String>,
175 _worktree: Option<&Worktree>,
176 ) -> Result<SlashCommandOutput, String> {
177 Err("`run_slash_command` not implemented".to_string())
178 }
179
180 /// Returns the command used to start a context server.
181 fn context_server_command(
182 &mut self,
183 _context_server_id: &ContextServerId,
184 _project: &Project,
185 ) -> Result<Command> {
186 Err("`context_server_command` not implemented".to_string())
187 }
188
189 /// Returns the configuration options for the specified context server.
190 fn context_server_configuration(
191 &mut self,
192 _context_server_id: &ContextServerId,
193 _project: &Project,
194 ) -> Result<Option<ContextServerConfiguration>> {
195 Ok(None)
196 }
197
198 /// Returns a list of package names as suggestions to be included in the
199 /// search results of the `/docs` slash command.
200 ///
201 /// This can be used to provide completions for known packages (e.g., from the
202 /// local project or a registry) before a package has been indexed.
203 fn suggest_docs_packages(&self, _provider: String) -> Result<Vec<String>, String> {
204 Ok(Vec::new())
205 }
206
207 /// Indexes the docs for the specified package.
208 fn index_docs(
209 &self,
210 _provider: String,
211 _package: String,
212 _database: &KeyValueStore,
213 ) -> Result<(), String> {
214 Err("`index_docs` not implemented".to_string())
215 }
216
217 /// Returns the debug adapter binary for the specified adapter name and configuration.
218 fn get_dap_binary(
219 &mut self,
220 _adapter_name: String,
221 _config: DebugTaskDefinition,
222 _user_provided_debug_adapter_path: Option<String>,
223 _worktree: &Worktree,
224 ) -> Result<DebugAdapterBinary, String> {
225 Err("`get_dap_binary` not implemented".to_string())
226 }
227
228 /// Determines whether the specified adapter configuration should *launch* a new debuggee process
229 /// or *attach* to an existing one. This function should not perform any further validation (outside of determining the kind of a request).
230 /// This function should return an error when the kind cannot be determined (rather than fall back to a known default).
231 fn dap_request_kind(
232 &mut self,
233 _adapter_name: String,
234 _config: serde_json::Value,
235 ) -> Result<StartDebuggingRequestArgumentsRequest, String> {
236 Err("`dap_request_kind` not implemented".to_string())
237 }
238 /// Converts a high-level definition of a debug scenario (originating in a new session UI) to a "low-level" configuration suitable for a particular adapter.
239 ///
240 /// In layman's terms: given a program, list of arguments, current working directory and environment variables,
241 /// create a configuration that can be used to start a debug session.
242 fn dap_config_to_scenario(&mut self, _config: DebugConfig) -> Result<DebugScenario, String> {
243 Err("`dap_config_to_scenario` not implemented".to_string())
244 }
245
246 /// Locators are entities that convert a Zed task into a debug scenario.
247 ///
248 /// They can be provided even by extensions that don't provide a debug adapter.
249 /// For all tasks applicable to a given buffer, Zed will query all locators to find one that can turn the task into a debug scenario.
250 /// A converted debug scenario can include a build task (it shouldn't contain any configuration in such case); a build task result will later
251 /// be resolved with [`Extension::run_dap_locator`].
252 ///
253 /// To work through a real-world example, take a `cargo run` task and a hypothetical `cargo` locator:
254 /// 1. We may need to modify the task; in this case, it is problematic that `cargo run` spawns a binary. We should turn `cargo run` into a debug scenario with
255 /// `cargo build` task. This is the decision we make at `dap_locator_create_scenario` scope.
256 /// 2. Then, after the build task finishes, we will run `run_dap_locator` of the locator that produced the build task to find the program to be debugged. This function
257 /// should give us a debugger-agnostic configuration for launching a debug target (that we end up resolving with [`Extension::dap_config_to_scenario`]). It's almost as if the user
258 /// found the artifact path by themselves.
259 ///
260 /// Note that you're not obliged to use build tasks with locators. Specifically, it is sufficient to provide a debug configuration directly in the return value of
261 /// `dap_locator_create_scenario` if you're able to do that. Make sure to not fill out `build` field in that case, as that will prevent Zed from running second phase of resolution in such case.
262 /// This might be of particular relevance to interpreted languages.
263 fn dap_locator_create_scenario(
264 &mut self,
265 _locator_name: String,
266 _build_task: TaskTemplate,
267 _resolved_label: String,
268 _debug_adapter_name: String,
269 ) -> Option<DebugScenario> {
270 None
271 }
272
273 /// Runs the second phase of locator resolution.
274 /// See [`Extension::dap_locator_create_scenario`] for a hefty comment on locators.
275 fn run_dap_locator(
276 &mut self,
277 _locator_name: String,
278 _build_task: TaskTemplate,
279 ) -> Result<DebugRequest, String> {
280 Err("`run_dap_locator` not implemented".to_string())
281 }
282
283 /// Returns information about language model providers offered by this extension.
284 fn llm_providers(&self) -> Vec<LlmProviderInfo> {
285 Vec::new()
286 }
287
288 /// Returns the models available for a provider.
289 fn llm_provider_models(&self, _provider_id: &str) -> Result<Vec<LlmModelInfo>, String> {
290 Ok(Vec::new())
291 }
292
293 /// Returns markdown content to display in the provider's settings UI.
294 /// This can include setup instructions, links to documentation, etc.
295 fn llm_provider_settings_markdown(&self, _provider_id: &str) -> Option<String> {
296 None
297 }
298
299 /// Check if the provider is authenticated.
300 fn llm_provider_is_authenticated(&self, _provider_id: &str) -> bool {
301 false
302 }
303
304 /// Start an OAuth device flow sign-in.
305 /// This is called when the user explicitly clicks "Sign in with GitHub" or similar.
306 /// Opens the browser to the verification URL and returns the user code that should
307 /// be displayed to the user.
308 fn llm_provider_start_device_flow_sign_in(
309 &mut self,
310 _provider_id: &str,
311 ) -> Result<String, String> {
312 Err("`llm_provider_start_device_flow_sign_in` not implemented".to_string())
313 }
314
315 /// Poll for device flow sign-in completion.
316 /// This is called after llm_provider_start_device_flow_sign_in returns the user code.
317 /// The extension should poll the OAuth provider until the user authorizes or the flow times out.
318 fn llm_provider_poll_device_flow_sign_in(&mut self, _provider_id: &str) -> Result<(), String> {
319 Err("`llm_provider_poll_device_flow_sign_in` not implemented".to_string())
320 }
321
322 /// Reset credentials for the provider.
323 fn llm_provider_reset_credentials(&mut self, _provider_id: &str) -> Result<(), String> {
324 Err("`llm_provider_reset_credentials` not implemented".to_string())
325 }
326
327 /// Count tokens for a request.
328 fn llm_count_tokens(
329 &self,
330 _provider_id: &str,
331 _model_id: &str,
332 _request: &LlmCompletionRequest,
333 ) -> Result<u64, String> {
334 Err("`llm_count_tokens` not implemented".to_string())
335 }
336
337 /// Start streaming a completion from the model.
338 /// Returns a stream ID that can be used with `llm_stream_completion_next` and `llm_stream_completion_close`.
339 fn llm_stream_completion_start(
340 &mut self,
341 _provider_id: &str,
342 _model_id: &str,
343 _request: &LlmCompletionRequest,
344 ) -> Result<String, String> {
345 Err("`llm_stream_completion_start` not implemented".to_string())
346 }
347
348 /// Get the next event from a completion stream.
349 /// Returns `Ok(None)` when the stream is complete.
350 fn llm_stream_completion_next(
351 &mut self,
352 _stream_id: &str,
353 ) -> Result<Option<LlmCompletionEvent>, String> {
354 Err("`llm_stream_completion_next` not implemented".to_string())
355 }
356
357 /// Close a completion stream and release its resources.
358 fn llm_stream_completion_close(&mut self, _stream_id: &str) {
359 // Default implementation does nothing
360 }
361
362 /// Get cache configuration for a model (if prompt caching is supported).
363 fn llm_cache_configuration(
364 &self,
365 _provider_id: &str,
366 _model_id: &str,
367 ) -> Option<LlmCacheConfiguration> {
368 None
369 }
370}
371
372/// Registers the provided type as a Zed extension.
373///
374/// The type must implement the [`Extension`] trait.
375#[macro_export]
376macro_rules! register_extension {
377 ($extension_type:ty) => {
378 #[cfg(target_os = "wasi")]
379 mod wasi_ext {
380 unsafe extern "C" {
381 static mut errno: i32;
382 pub static mut __wasilibc_cwd: *mut std::ffi::c_char;
383 }
384
385 pub fn init_cwd() {
386 unsafe {
387 // Ensure that our chdir function is linked, instead of the
388 // one from wasi-libc in the chdir.o translation unit. Otherwise
389 // we risk linking in `__wasilibc_find_relpath_alloc` which
390 // is a weak symbol and is being used by
391 // `__wasilibc_find_relpath`, which we do not want on
392 // Windows.
393 chdir(std::ptr::null());
394
395 __wasilibc_cwd = std::ffi::CString::new(std::env::var("PWD").unwrap())
396 .unwrap()
397 .into_raw()
398 .cast();
399 }
400 }
401
402 #[unsafe(no_mangle)]
403 pub unsafe extern "C" fn chdir(raw_path: *const std::ffi::c_char) -> i32 {
404 // Forbid extensions from changing CWD and so return an appropriate error code.
405 errno = 58; // NOTSUP
406 return -1;
407 }
408 }
409
410 #[unsafe(export_name = "init-extension")]
411 pub extern "C" fn __init_extension() {
412 #[cfg(target_os = "wasi")]
413 wasi_ext::init_cwd();
414
415 zed_extension_api::register_extension(|| {
416 Box::new(<$extension_type as zed_extension_api::Extension>::new())
417 });
418 }
419 };
420}
421
422#[doc(hidden)]
423pub fn register_extension(build_extension: fn() -> Box<dyn Extension>) {
424 unsafe { EXTENSION = Some((build_extension)()) }
425}
426
427fn extension() -> &'static mut dyn Extension {
428 #[expect(static_mut_refs)]
429 unsafe {
430 EXTENSION.as_deref_mut().unwrap()
431 }
432}
433
434static mut EXTENSION: Option<Box<dyn Extension>> = None;
435
436#[cfg(target_arch = "wasm32")]
437#[unsafe(link_section = "zed:api-version")]
438#[doc(hidden)]
439pub static ZED_API_VERSION: [u8; 6] = *include_bytes!(concat!(env!("OUT_DIR"), "/version_bytes"));
440
441mod wit {
442
443 wit_bindgen::generate!({
444 skip: ["init-extension"],
445 path: "./wit/since_v0.8.0",
446 });
447}
448
449wit::export!(Component);
450
451struct Component;
452
453impl wit::Guest for Component {
454 fn language_server_command(
455 language_server_id: String,
456 worktree: &wit::Worktree,
457 ) -> Result<wit::Command> {
458 let language_server_id = LanguageServerId(language_server_id);
459 extension().language_server_command(&language_server_id, worktree)
460 }
461
462 fn language_server_initialization_options(
463 language_server_id: String,
464 worktree: &Worktree,
465 ) -> Result<Option<String>, String> {
466 let language_server_id = LanguageServerId(language_server_id);
467 Ok(extension()
468 .language_server_initialization_options(&language_server_id, worktree)?
469 .and_then(|value| serde_json::to_string(&value).ok()))
470 }
471
472 fn language_server_workspace_configuration(
473 language_server_id: String,
474 worktree: &Worktree,
475 ) -> Result<Option<String>, String> {
476 let language_server_id = LanguageServerId(language_server_id);
477 Ok(extension()
478 .language_server_workspace_configuration(&language_server_id, worktree)?
479 .and_then(|value| serde_json::to_string(&value).ok()))
480 }
481
482 fn language_server_additional_initialization_options(
483 language_server_id: String,
484 target_language_server_id: String,
485 worktree: &Worktree,
486 ) -> Result<Option<String>, String> {
487 let language_server_id = LanguageServerId(language_server_id);
488 let target_language_server_id = LanguageServerId(target_language_server_id);
489 Ok(extension()
490 .language_server_additional_initialization_options(
491 &language_server_id,
492 &target_language_server_id,
493 worktree,
494 )?
495 .and_then(|value| serde_json::to_string(&value).ok()))
496 }
497
498 fn language_server_additional_workspace_configuration(
499 language_server_id: String,
500 target_language_server_id: String,
501 worktree: &Worktree,
502 ) -> Result<Option<String>, String> {
503 let language_server_id = LanguageServerId(language_server_id);
504 let target_language_server_id = LanguageServerId(target_language_server_id);
505 Ok(extension()
506 .language_server_additional_workspace_configuration(
507 &language_server_id,
508 &target_language_server_id,
509 worktree,
510 )?
511 .and_then(|value| serde_json::to_string(&value).ok()))
512 }
513
514 fn labels_for_completions(
515 language_server_id: String,
516 completions: Vec<Completion>,
517 ) -> Result<Vec<Option<CodeLabel>>, String> {
518 let language_server_id = LanguageServerId(language_server_id);
519 let mut labels = Vec::new();
520 for (ix, completion) in completions.into_iter().enumerate() {
521 let label = extension().label_for_completion(&language_server_id, completion);
522 if let Some(label) = label {
523 labels.resize(ix + 1, None);
524 *labels.last_mut().unwrap() = Some(label);
525 }
526 }
527 Ok(labels)
528 }
529
530 fn labels_for_symbols(
531 language_server_id: String,
532 symbols: Vec<Symbol>,
533 ) -> Result<Vec<Option<CodeLabel>>, String> {
534 let language_server_id = LanguageServerId(language_server_id);
535 let mut labels = Vec::new();
536 for (ix, symbol) in symbols.into_iter().enumerate() {
537 let label = extension().label_for_symbol(&language_server_id, symbol);
538 if let Some(label) = label {
539 labels.resize(ix + 1, None);
540 *labels.last_mut().unwrap() = Some(label);
541 }
542 }
543 Ok(labels)
544 }
545
546 fn complete_slash_command_argument(
547 command: SlashCommand,
548 args: Vec<String>,
549 ) -> Result<Vec<SlashCommandArgumentCompletion>, String> {
550 extension().complete_slash_command_argument(command, args)
551 }
552
553 fn run_slash_command(
554 command: SlashCommand,
555 args: Vec<String>,
556 worktree: Option<&Worktree>,
557 ) -> Result<SlashCommandOutput, String> {
558 extension().run_slash_command(command, args, worktree)
559 }
560
561 fn context_server_command(
562 context_server_id: String,
563 project: &Project,
564 ) -> Result<wit::Command> {
565 let context_server_id = ContextServerId(context_server_id);
566 extension().context_server_command(&context_server_id, project)
567 }
568
569 fn context_server_configuration(
570 context_server_id: String,
571 project: &Project,
572 ) -> Result<Option<ContextServerConfiguration>, String> {
573 let context_server_id = ContextServerId(context_server_id);
574 extension().context_server_configuration(&context_server_id, project)
575 }
576
577 fn suggest_docs_packages(provider: String) -> Result<Vec<String>, String> {
578 extension().suggest_docs_packages(provider)
579 }
580
581 fn index_docs(
582 provider: String,
583 package: String,
584 database: &KeyValueStore,
585 ) -> Result<(), String> {
586 extension().index_docs(provider, package, database)
587 }
588
589 fn get_dap_binary(
590 adapter_name: String,
591 config: DebugTaskDefinition,
592 user_installed_path: Option<String>,
593 worktree: &Worktree,
594 ) -> Result<wit::DebugAdapterBinary, String> {
595 extension().get_dap_binary(adapter_name, config, user_installed_path, worktree)
596 }
597
598 fn dap_request_kind(
599 adapter_name: String,
600 config: String,
601 ) -> Result<StartDebuggingRequestArgumentsRequest, String> {
602 extension().dap_request_kind(
603 adapter_name,
604 serde_json::from_str(&config).map_err(|e| format!("Failed to parse config: {e}"))?,
605 )
606 }
607 fn dap_config_to_scenario(config: DebugConfig) -> Result<DebugScenario, String> {
608 extension().dap_config_to_scenario(config)
609 }
610 fn dap_locator_create_scenario(
611 locator_name: String,
612 build_task: TaskTemplate,
613 resolved_label: String,
614 debug_adapter_name: String,
615 ) -> Option<DebugScenario> {
616 extension().dap_locator_create_scenario(
617 locator_name,
618 build_task,
619 resolved_label,
620 debug_adapter_name,
621 )
622 }
623 fn run_dap_locator(
624 locator_name: String,
625 build_task: TaskTemplate,
626 ) -> Result<DebugRequest, String> {
627 extension().run_dap_locator(locator_name, build_task)
628 }
629
630 fn llm_providers() -> Vec<LlmProviderInfo> {
631 extension().llm_providers()
632 }
633
634 fn llm_provider_models(provider_id: String) -> Result<Vec<LlmModelInfo>, String> {
635 extension().llm_provider_models(&provider_id)
636 }
637
638 fn llm_provider_settings_markdown(provider_id: String) -> Option<String> {
639 extension().llm_provider_settings_markdown(&provider_id)
640 }
641
642 fn llm_provider_is_authenticated(provider_id: String) -> bool {
643 extension().llm_provider_is_authenticated(&provider_id)
644 }
645
646 fn llm_provider_start_device_flow_sign_in(provider_id: String) -> Result<String, String> {
647 extension().llm_provider_start_device_flow_sign_in(&provider_id)
648 }
649
650 fn llm_provider_poll_device_flow_sign_in(provider_id: String) -> Result<(), String> {
651 extension().llm_provider_poll_device_flow_sign_in(&provider_id)
652 }
653
654 fn llm_provider_reset_credentials(provider_id: String) -> Result<(), String> {
655 extension().llm_provider_reset_credentials(&provider_id)
656 }
657
658 fn llm_count_tokens(
659 provider_id: String,
660 model_id: String,
661 request: LlmCompletionRequest,
662 ) -> Result<u64, String> {
663 extension().llm_count_tokens(&provider_id, &model_id, &request)
664 }
665
666 fn llm_stream_completion_start(
667 provider_id: String,
668 model_id: String,
669 request: LlmCompletionRequest,
670 ) -> Result<String, String> {
671 extension().llm_stream_completion_start(&provider_id, &model_id, &request)
672 }
673
674 fn llm_stream_completion_next(stream_id: String) -> Result<Option<LlmCompletionEvent>, String> {
675 extension().llm_stream_completion_next(&stream_id)
676 }
677
678 fn llm_stream_completion_close(stream_id: String) {
679 extension().llm_stream_completion_close(&stream_id)
680 }
681
682 fn llm_cache_configuration(
683 provider_id: String,
684 model_id: String,
685 ) -> Option<LlmCacheConfiguration> {
686 extension().llm_cache_configuration(&provider_id, &model_id)
687 }
688}
689
690/// The ID of a language server.
691#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
692pub struct LanguageServerId(String);
693
694impl AsRef<str> for LanguageServerId {
695 fn as_ref(&self) -> &str {
696 &self.0
697 }
698}
699
700impl fmt::Display for LanguageServerId {
701 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
702 write!(f, "{}", self.0)
703 }
704}
705
706/// The ID of a context server.
707#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
708pub struct ContextServerId(String);
709
710impl AsRef<str> for ContextServerId {
711 fn as_ref(&self) -> &str {
712 &self.0
713 }
714}
715
716impl fmt::Display for ContextServerId {
717 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
718 write!(f, "{}", self.0)
719 }
720}
721
722impl CodeLabelSpan {
723 /// Returns a [`CodeLabelSpan::CodeRange`].
724 pub fn code_range(range: impl Into<wit::Range>) -> Self {
725 Self::CodeRange(range.into())
726 }
727
728 /// Returns a [`CodeLabelSpan::Literal`].
729 pub fn literal(text: impl Into<String>, highlight_name: Option<String>) -> Self {
730 Self::Literal(CodeLabelSpanLiteral {
731 text: text.into(),
732 highlight_name,
733 })
734 }
735}
736
737impl From<std::ops::Range<u32>> for wit::Range {
738 fn from(value: std::ops::Range<u32>) -> Self {
739 Self {
740 start: value.start,
741 end: value.end,
742 }
743 }
744}
745
746impl From<std::ops::Range<usize>> for wit::Range {
747 fn from(value: std::ops::Range<usize>) -> Self {
748 Self {
749 start: value.start as u32,
750 end: value.end as u32,
751 }
752 }
753}