Skip to main content

Command

Enum Command 

Source
#[repr(u8)]
pub enum Command { DpRead = 0, DpWrite = 1, ApRead = 2, ApWrite = 3, ApBulkRead = 18, ApBulkWrite = 19, MultiRegWrite = 20, Ping = 240, ResetTarget = 241, Clock = 242, SetSpeed = 243, Disconnect = 255, }
Expand description

Binary API single byte command codes

Variants§

§

DpRead = 0

§

DpWrite = 1

§

ApRead = 2

§

ApWrite = 3

§

ApBulkRead = 18

§

ApBulkWrite = 19

§

MultiRegWrite = 20

§

Ping = 240

§

ResetTarget = 241

§

Clock = 242

§

SetSpeed = 243

§

Disconnect = 255

Implementations§

Source§

impl Command

Source

pub fn to_byte(self) -> u8

Converts a Command to its byte representation

Returns:

  • u8: The byte representation of the command.
Source

pub fn from_byte(cmd: u8) -> Result<Self, ProtocolError>

Convert a command byte to a Command enum variant

Arguments:

  • cmd: The command byte to convert.

Returns:

  • Ok(Command): If the command byte is recognized.
  • Err(ProtocolError::Command): If the command byte is not recognized.
Source

pub fn remaining_bytes(&self) -> Result<(usize, bool), ProtocolError>

Determine how many more bytes to read for this command type

Returns:

  • Ok((usize, bool)): The number of bytes needed and whether the command will receive additional data (i.e. is a bulk command).
  • Err(SwdError::Api): If the command is not recognized.
Source

pub fn var_bytes(&self, count: u16) -> Result<usize, ProtocolError>

Determines how many variable bytes this command requires

Arguments:

  • count: The number of words to read for bulk commands.

Returns:

  • Ok(usize): The number of bytes to read for the command.
  • Err(SwdError::Api): If the command is not recognized or if the count is invalid.

Trait Implementations§

Source§

impl Clone for Command

Source§

fn clone(&self) -> Command

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Command

Source§

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

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

impl Display for Command

Source§

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

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

impl PartialEq for Command

Source§

fn eq(&self, other: &Command) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Command

Source§

impl Eq for Command

Source§

impl StructuralPartialEq for Command

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.