Struct SmartPort

pub struct SmartPort { /* private fields */ }

Represents a Smart Port on a V5 Brain

Implementations

impl SmartPort

pub const unsafe fn new(number: 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 number(&self) -> u8

Returns the number of the port.

Ports are numbered starting from 1.

Examples

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

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

pub fn device_type(&self) -> Option<SmartDeviceType>

Returns the type of device currently connected to this port, or None if no device is connected.

Examples

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

if let Some(device_type) = my_port.device_type() {
    println!("Type of device connected to port 1: {:?}", device_type);
}

pub fn validate_type( &self, device_type: SmartDeviceType, ) -> Result<(), PortError>

Verify that a device type is currently plugged into this port, returning an appropriate PortError if not available.

Errors

Returns a PortError if there is not a device of the specified type in this port.

Trait Implementations

impl Debug for SmartPort

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

Formats the value using the given formatter.

impl From<AdiExpander> for SmartPort

fn from(device: AdiExpander) -> Self

Converts to this type from the input type.

impl From<AiVisionSensor> for SmartPort

fn from(val: AiVisionSensor) -> Self

Converts to this type from the input type.

impl From<DistanceSensor> for SmartPort

fn from(device: DistanceSensor) -> Self

Converts to this type from the input type.

impl From<Electromagnet> for SmartPort

fn from(device: Electromagnet) -> Self

Converts to this type from the input type.

impl From<GpsSensor> for SmartPort

fn from(device: GpsSensor) -> Self

Converts to this type from the input type.

impl From<InertialSensor> for SmartPort

fn from(device: InertialSensor) -> Self

Converts to this type from the input type.

impl From<Motor> for SmartPort

fn from(device: Motor) -> Self

Converts to this type from the input type.

impl From<OpticalSensor> for SmartPort

fn from(device: OpticalSensor) -> Self

Converts to this type from the input type.

impl From<RadioLink> for SmartPort

fn from(device: RadioLink) -> Self

Converts to this type from the input type.

impl From<RotationSensor> for SmartPort

fn from(device: RotationSensor) -> Self

Converts to this type from the input type.

impl From<SerialPort> for SmartPort

fn from(device: SerialPort) -> Self

Converts to this type from the input type.

impl From<VisionSensor> for SmartPort

fn from(device: VisionSensor) -> Self

Converts to this type from the input type.

impl PartialEq for SmartPort

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

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

const 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 Eq for SmartPort

impl StructuralPartialEq for SmartPort