Struct pros_devices::smart::SmartPort

pub struct SmartPort { /* private fields */ }

Represents a smart port on a V5 Brain

Implementations

impl SmartPort

pub const unsafe fn new(index: u8) -> Self

Creates a new smart port on a specified index.

Safety

Creating new SmartPorts is inherently unsafe due to the possibility of constructing more than one device on the same port index allowing multiple mutable references to the same hardware device. This violates rust’s borrow checked guarantees. Prefer using Peripherals to register devices if possible.

Examples

// Create a new smart port at index 1.
// This is unsafe! You are responsible for ensuring that only one device registered on a
// single port index.
let my_port = unsafe { SmartPort::new(1) };

pub const fn index(&self) -> u8

Get the index of the port (port number).

Ports are indexed starting from 1.

Examples

let my_port = unsafe { SmartPort::new(1) };

assert_eq!(my_port.index(), 1);

pub fn connected_type(&self) -> Result<SmartDeviceType, PortError>

Get the type of device currently connected to this port.

Examples

let my_port = unsafe { SmartPort::new(1) };

println!("Type of device connected to port 1: {:?}", my_port.connected_type()?);

pub fn configured_type(&self) -> Result<SmartDeviceType, PortError>

Get the type of device this port is configured as.

Examples

let my_port = unsafe { SmartPort::new(1) };
let imu = InertialSensor::new(my_port)?;

assert_eq!(my_port.configured_type()?, SmartDeviceType::Imu);

Trait Implementations

impl Debug for SmartPort

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

Formats the value using the given formatter.

impl PartialEq for SmartPort

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SmartPort

impl StructuralPartialEq for SmartPort