Enum GenericConnection 

pub enum GenericConnection {
    Bluetooth(BluetoothConnection),
    Serial(SerialConnection),
}

Variants

Bluetooth(BluetoothConnection)

Serial(SerialConnection)

Implementations

impl GenericConnection

pub fn is_bluetooth(&self) -> bool

Returns whether the connection is over bluetooth.

pub fn is_wired(&self) -> bool

Returns whether the connection is over serial.

pub fn is_controller(&self) -> bool

Returns whether the connection is a controller.

pub async fn is_paired(&self) -> Result<bool, GenericError>

Checks if the connection is paired. If the connection is not over bluetooth, this function will return an error.

pub async fn request_pairing(&mut self) -> Result<(), GenericError>

Requests pairing with the device.

Errors

If the connection is not over bluetooth, this function will return an error. This function will also error if there is a communication error while requesting pairing.

pub async fn authenticate_pairing( &mut self, pin: [u8; 4], ) -> Result<(), GenericError>

Attempts to authenticate the pairing request with the given pin. If the connection is not over bluetooth, this function will return an error.

Trait Implementations

impl Connection for GenericConnection

type Error = GenericError

fn connection_type(&self) -> ConnectionType

async fn send(&mut self, packet: impl Encode) -> Result<(), GenericError>

Sends a packet.

async fn recv<P: Decode + CheckHeader>( &mut self, timeout: Duration, ) -> Result<P, GenericError>

Receives a packet.

async fn read_user(&mut self, buf: &mut [u8]) -> Result<usize, GenericError>

Read user program output.

async fn write_user(&mut self, buf: &[u8]) -> Result<usize, GenericError>

Write to user program stdio.

fn execute_command<C: Command>( &mut self, command: C, ) -> impl Future<Output = Result<C::Output, Self::Error>>

Executes a Command.

async fn handshake<D: Decode + CheckHeader>( &mut self, timeout: Duration, retries: usize, packet: impl Encode + Clone, ) -> Result<D, Self::Error>

Sends a packet and waits for a response.

impl From<BluetoothConnection> for GenericConnection

fn from(c: BluetoothConnection) -> Self

Converts to this type from the input type.

impl From<SerialConnection> for GenericConnection

fn from(c: SerialConnection) -> Self

Converts to this type from the input type.