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 connect_under_reset: bool,
    pub speed: Option<u32>,
    pub dry_run: bool,
}

Common options and logic when interfacing with a Probe.

Fields

chip: Option<String>

chip_description_path: Option<PathBuf>

protocol: Option<WireProtocol>

probe_selector: Option<DebugProbeSelector>

connect_under_reset: bool

speed: Option<u32>

dry_run: 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 Debug for ProbeOptions

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

Formats the value using the given formatter.

impl StructOpt for ProbeOptions

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.