Documentation for GetSpanContents engine call (#1362)

nushell · Apr 30, 2024 · 5c82772 · 5c82772
1 parent fb08c9f
commit 5c82772
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/contributor-book/plugin_protocol_reference.md b/contributor-book/plugin_protocol_reference.md
@@ -806,6 +806,27 @@ Example:
 }
 ```
 
+#### `GetSpanContents` engine call
+
+Get the contents of a [`Span`](#span) from the engine. This can be used for viewing the source code that generated a value. The argument is a [`Span`](#span). The response on success is [`Value` pipeline data](3pipelinedataheader-value) containing a [`Binary`](#binary) value, as the result is not guaranteed to be valid UTF-8.
+
+Example:
+
+```json
+{
+ "EngineCall": {
+ "context": 40,
+ "id": 72,
+ "call": {
+ "GetSpanContents": {
+ "start": 38881,
+ "end": 39007
+ }
+ }
+ }
+}
+```
+
 #### `EvalClosure` engine call
 
 Pass a [`Closure`](#closure) and arguments to the engine to be evaluated. Returns a [`PipelineData` response](#pipelinedata-engine-call-response) if successful with the output of the closure, which may be a stream.