Struct probe_rs::Probe

pub struct Probe { /* fields omitted */ }

The Probe struct is a generic wrapper over the different probes supported.

Examples

Open the first probe found

The list_all and from_probe_info functions can be used to create a new Probe:

use probe_rs::Probe;

let probe_list = Probe::list_all();
let probe = Probe::from_probe_info(&probe_list[0]);

Methods

impl Probe

pub fn new(probe: impl DebugProbe + 'static) -> Self

pub fn list_all() -> Vec<DebugProbeInfo>

Get a list of all debug probes found. This can be used to select the debug probe which should be used.

pub fn from_probe_info(info: &DebugProbeInfo) -> Result<Self, DebugProbeError>

Create a Probe from DebugProbeInfo. Use the Probe::list_all() function to get the information about all probes available.

pub fn from_specific_probe(probe: Box<dyn DebugProbe>) -> Self

pub fn get_name(&self) -> String

Get human readable name for the probe

pub fn attach(self, target: impl Into<TargetSelector>) -> Result<Session, Error>

Enters debug mode

pub fn select_protocol(
    &mut self,
    protocol: WireProtocol
) -> Result<(), DebugProbeError>

Selects the transport protocol to be used by the debug probe.

pub fn detach(&mut self) -> Result<(), DebugProbeError>

Leave debug mode

pub fn target_reset(&mut self) -> Result<(), DebugProbeError>

Resets the target device.

pub fn dedicated_memory_interface(&self) -> Option<Memory>

Returns a probe specific memory interface if any is present for given probe.

pub fn has_dap_interface(&self) -> bool

pub fn get_interface_dap(&self) -> Option<&dyn DAPAccess>

pub fn get_interface_dap_mut(&mut self) -> Option<&mut dyn DAPAccess>

pub fn has_jtag_interface(&self) -> bool

pub fn get_interface_jtag(&self) -> Option<&dyn JTAGAccess>

pub fn get_interface_jtag_mut(&mut self) -> Option<&mut dyn JTAGAccess>

Trait Implementations

impl Debug for Probe

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

Formats the value using the given formatter.