Enum ErrorCode

#[repr(i32)]
pub enum ErrorCode {
    OK = 0,
    CAN_MSG_STALE = 1,
    TxFailed = -1,
    InvalidParamValue = -2,
    RxTimeout = -3,
    TxTimeout = -4,
    UnexpectedArbId = -5,
    BufferFull = 6,
    CAN_OVERFLOW = -6,
    SensorNotPresent = -7,
    FirmwareTooOld = -8,
    CouldNotChangePeriod = -9,
    GeneralError = -100,
    SigNotUpdated = -200,
    NotAllPIDValuesUpdated = -201,
    GEN_PORT_ERROR = -300,
    PORT_MODULE_TYPE_MISMATCH = -301,
    GEN_MODULE_ERROR = -400,
    MODULE_NOT_INIT_SET_ERROR = -401,
    MODULE_NOT_INIT_GET_ERROR = -402,
    WheelRadiusTooSmall = -500,
    TicksPerRevZero = -501,
    DistanceBetweenWheelsTooSmall = -502,
    GainsAreNotSet = -503,
    IncompatibleMode = -600,
    InvalidHandle = -601,
    FeatureRequiresHigherFirm = -700,
    TalonFeatureRequiresHigherFirm = -701,
    PulseWidthSensorNotPresent = 10,
    GeneralWarning = 100,
    FeatureNotSupported = 101,
    NotImplemented = 102,
    FirmVersionCouldNotBeRetrieved = 103,
    FeaturesNotAvailableYet = 104,
    ControlModeNotValid = 105,
    ControlModeNotSupportedYet = 106,
    AuxiliaryPIDNotSupportedYet = 107,
    RemoteSensorsNotSupportedYet = 108,
    MotProfFirmThreshold = 109,
    MotProfFirmThreshold2 = 110,
}

Variants

OK = 0

No Error - Function executed as expected

CAN_MSG_STALE = 1

TxFailed = -1

Could not transmit the CAN frame.

InvalidParamValue = -2

Caller passed an invalid param

RxTimeout = -3

CAN frame has not been received within specified period of time.

TxTimeout = -4

Not used.

UnexpectedArbId = -5

Specified CAN Id is invalid.

BufferFull = 6

Caller attempted to insert data into a buffer that is full.

CAN_OVERFLOW = -6

SensorNotPresent = -7

Sensor is not present

FirmwareTooOld = -8

CouldNotChangePeriod = -9

GeneralError = -100

User Specified General Error

SigNotUpdated = -200

Have not received an value response for signal.

NotAllPIDValuesUpdated = -201

GEN_PORT_ERROR = -300

PORT_MODULE_TYPE_MISMATCH = -301

GEN_MODULE_ERROR = -400

MODULE_NOT_INIT_SET_ERROR = -401

MODULE_NOT_INIT_GET_ERROR = -402

WheelRadiusTooSmall = -500

TicksPerRevZero = -501

DistanceBetweenWheelsTooSmall = -502

GainsAreNotSet = -503

IncompatibleMode = -600

InvalidHandle = -601

Handle does not match stored map of handles

FeatureRequiresHigherFirm = -700

TalonFeatureRequiresHigherFirm = -701

PulseWidthSensorNotPresent = 10

Special Code for “isSensorPresent”

GeneralWarning = 100

FeatureNotSupported = 101

feature not implement in the API or firmware

NotImplemented = 102

feature not implement in the API

FirmVersionCouldNotBeRetrieved = 103

FeaturesNotAvailableYet = 104

feature will be release in an upcoming release

ControlModeNotValid = 105

Current control mode of motor controller not valid for this call

ControlModeNotSupportedYet = 106

AuxiliaryPIDNotSupportedYet = 107

RemoteSensorsNotSupportedYet = 108

MotProfFirmThreshold = 109

MotProfFirmThreshold2 = 110

Implementations

impl ErrorCode

pub fn is_ok(self) -> bool

Returns true if the error code is OK.

pub fn is_err(self) -> bool

Returns true if the error code is not OK.

pub fn or(self, err: ErrorCode) -> ErrorCode

Returns err if self is OK, otherwise returns self. Intended for use by the ctre crate only.

pub fn into_res(self) -> Result<(), ErrorCode>

Returns an Ok if the error code is OK, or an Err otherwise.

Examples found in repository

examples/simple_robot.rs (line 13)

fn main() -> ctre::Result<()> {
    let talon = TalonSRX::new(0);
    let delay = time::Duration::from_millis(20);
    talon.config_forward_limit_switch_source(
        LimitSwitchSource::FeedbackConnector,
        LimitSwitchNormal::NormallyOpen,
        10,
    ).into_res()?;
    loop {
        talon.set(ControlMode::PercentOutput, 0.5, DemandType::Neutral, 0.0);
        thread::sleep(delay);
        talon.neutral_output();
        thread::sleep(delay);
    }
}

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl Error for ErrorCode

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Hash for ErrorCode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode