Struct probe_rs_cli_util::common_options::ProbeOptions

pub struct ProbeOptions {
    pub chip: Option<String>,
    pub chip_description_path: Option<PathBuf>,
    pub protocol: Option<WireProtocol>,
    pub probe_selector: Option<DebugProbeSelector>,
    pub speed: Option<u32>,
    pub connect_under_reset: bool,
    pub dry_run: bool,
    pub allow_erase_all: bool,
}

Common options and logic when interfacing with a Probe.

Fields

chip: Option<String>

chip_description_path: Option<PathBuf>

protocol: Option<WireProtocol>

Protocol used to connect to chip. Possible options: [swd, jtag]

probe_selector: Option<DebugProbeSelector>

Use this flag to select a specific probe in the list.

Use ‘–probe VID:PID’ or ‘–probe VID:PID:Serial’ if you have more than one probe with the same VID:PID.“,

speed: Option<u32>

connect_under_reset: bool

dry_run: bool

allow_erase_all: bool

Implementations

impl ProbeOptions

pub fn maybe_load_chip_desc(&self) -> Result<(), OperationError>

Add targets contained in file given by –chip-description-path to probe-rs registery.

Note: should be called before FlashOptions::early_exit and any other functions in ProbeOptions.

pub fn get_target_selector(&self) -> Result<TargetSelector, OperationError>

Resolves a resultant target selector from passed ProbeOptions.

pub fn attach_probe(&self) -> Result<Probe, OperationError>

Attaches to specified probe and configures it.

pub fn attach_session(
    &self,
    probe: Probe,
    target: TargetSelector
) -> Result<Session, OperationError>

Attaches to target device session. Attaches under reset if specified by ProbeOptions::connect_under_reset.

pub fn simple_attach(&self) -> Result<Session, OperationError>

Convenience method that attaches to the specified probe, target, and target session.

pub fn build_flashloader(
    &self,
    session: &mut Session,
    elf_path: &Path
) -> Result<FlashLoader, OperationError>

Builds a new flash loader for the given target and ELF. This will check the ELF for validity and check what pages have to be flashed etc.

Trait Implementations

impl Args for ProbeOptions

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl CommandFactory for ProbeOptions

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ProbeOptions

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

Formats the value using the given formatter.

impl FromArgMatches for ProbeOptions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ProbeOptions

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.