Skip to main content

DebugAdapter

Struct DebugAdapter 

Source
pub struct DebugAdapter { /* private fields */ }
Expand description

A state-machine-based DAP client that manages a debug adapter process.

Handles spawning the debug adapter, performing the DAP initialize and launch/attach handshakes, sending requests, and processing responses. All state transitions are validated to maintain the lifecycle invariant.

§Concurrency

Same as LspClient – state in Arc<Mutex<>>, separate from process/writer. Lock ordering: state -> process -> writer -> pending_responses.

Implementations§

Source§

impl DebugAdapter

Source

pub fn new( session: DebugSession, adapter_command: String, adapter_args: Vec<String>, ) -> Self

Creates a new debug adapter in the Stopped state.

  • session — The debug session this adapter belongs to.
  • adapter_command — The command to spawn the debug adapter (e.g., “/usr/bin/gdb”).
  • adapter_args — Arguments to pass to the adapter command.
Source

pub async fn get_state(&self) -> DebugAdapterState

Returns the current state of the debug adapter.

Source

pub async fn start(&self) -> Result<(), String>

Spawns the debug adapter process and begins the initialization sequence.

Transitions from Stopped to Starting to Initializing. If spawning fails, transitions to Crashed. A background task is spawned to read responses from the adapter’s stdout.

Returns Ok(()) if the process was spawned successfully, or an error describing the failure.

Source

pub async fn stop(&self) -> Result<(), String>

Source

pub async fn is_running(&self) -> bool

Source

pub async fn initialize(&self) -> Result<Value, String>

Examples found in repository?
examples/gdb_session.rs (line 28)
8async fn main() -> Result<(), Box<dyn std::error::Error>> {
9    // Register the debug adapter
10    let pool = DebugAdapterPool::new();
11    pool
12        .register_adapter(
13            "cppdbg".to_string(),
14            "/usr/bin/gdb".to_string(),
15            vec!["--interpreter=dap".to_string()],
16        )
17        .await;
18
19    // Create a debug session
20    let manager = DebugManager::new();
21    let session_id = manager.create_session("main".to_string(), "cppdbg".to_string())?;
22    let session = manager.get_session(&session_id).unwrap();
23
24    // Start the adapter
25    let adapter = pool.create_session(session).await?;
26
27    // Initialize and set breakpoints
28    adapter.initialize().await?;
29    adapter
30        .set_breakpoints(
31            serde_json::json!({ "path": "/path/to/source.cpp" }),
32            vec![SourceBreakpoint {
33                line: 10,
34                column: None,
35                condition: None,
36                hit_condition: None,
37                log_message: None,
38            }],
39        )
40        .await?;
41
42    println!("Debug session initialized with breakpoints.");
43    Ok(())
44}
Source

pub async fn launch(&self, configuration: Value) -> Result<(), String>

Source

pub async fn attach(&self, configuration: Value) -> Result<(), String>

Source

pub async fn set_breakpoints( &self, source: Value, breakpoints: Vec<SourceBreakpoint>, ) -> Result<Vec<Breakpoint>, String>

Examples found in repository?
examples/gdb_session.rs (lines 30-39)
8async fn main() -> Result<(), Box<dyn std::error::Error>> {
9    // Register the debug adapter
10    let pool = DebugAdapterPool::new();
11    pool
12        .register_adapter(
13            "cppdbg".to_string(),
14            "/usr/bin/gdb".to_string(),
15            vec!["--interpreter=dap".to_string()],
16        )
17        .await;
18
19    // Create a debug session
20    let manager = DebugManager::new();
21    let session_id = manager.create_session("main".to_string(), "cppdbg".to_string())?;
22    let session = manager.get_session(&session_id).unwrap();
23
24    // Start the adapter
25    let adapter = pool.create_session(session).await?;
26
27    // Initialize and set breakpoints
28    adapter.initialize().await?;
29    adapter
30        .set_breakpoints(
31            serde_json::json!({ "path": "/path/to/source.cpp" }),
32            vec![SourceBreakpoint {
33                line: 10,
34                column: None,
35                condition: None,
36                hit_condition: None,
37                log_message: None,
38            }],
39        )
40        .await?;
41
42    println!("Debug session initialized with breakpoints.");
43    Ok(())
44}
Source

pub async fn continue_execution(&self, thread_id: i32) -> Result<(), String>

Source

pub async fn pause(&self, thread_id: i32) -> Result<(), String>

Source

pub async fn next(&self, thread_id: i32) -> Result<(), String>

Source

pub async fn step_in(&self, thread_id: i32) -> Result<(), String>

Source

pub async fn step_out(&self, thread_id: i32) -> Result<(), String>

Source

pub async fn disconnect(&self) -> Result<(), String>

Trait Implementations§

Source§

impl Debug for DebugAdapter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for DebugAdapter

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

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§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more