Struct CdcSerial

pub struct CdcSerial { /* private fields */ }

This is currently a thin wrapper of USB operations, it requires hardware buffers at the device side. It uses the CDC ACM Data Interface Class to transfer data (the Communication Interface Class is used for probing and serial configuration).

Reference: USB Class Definitions for Communication Devices, Version 1.1, especially section 3.6.2.1, 5.2.3.2 and 6.2(.13).

Implementations

impl CdcSerial

pub fn probe() -> Result<Vec<DeviceInfo>>

Probes for CDC-ACM devices. It checks the current configuration of each device. Returns an empty vector if no device is found.

pub fn build(dev_info: &DeviceInfo, timeout: Duration) -> Result<Self>

Connects to the CDC-ACM device, returns the CdcSerial handler. Please get permission for the device before calling this function.

• timeout: Set for standard Read and Write traits.

pub fn set_config(&mut self, conf: SerialConfig) -> Result<()>

Applies serial parameters.

Trait Implementations

impl Read for CdcSerial

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl SerialPort for CdcSerial

fn set_timeout(&mut self, timeout: Duration) -> Result<()>

Sets timeout for standard Read and Write implementations to do USB bulk transfers.

fn read_clear_to_send(&mut self) -> Result<bool>

Unsupported.

fn read_data_set_ready(&mut self) -> Result<bool>

Unsupported.

fn read_ring_indicator(&mut self) -> Result<bool>

Unsupported.

fn read_carrier_detect(&mut self) -> Result<bool>

Unsupported.

fn bytes_to_read(&self) -> Result<u32>

Returns 0 because no buffer is maintained here, and all operations are synchronous.

fn bytes_to_write(&self) -> Result<u32>

Returns 0 because no buffer is maintained here, and all operations are synchronous.

fn clear(&self, _buffer_to_clear: ClearBuffer) -> Result<()>

Does nothing.

fn try_clone(&self) -> Result<Box<dyn SerialPort>>

Unsupported.

fn name(&self) -> Option<String>

Returns the name of this port if it exists.

fn baud_rate(&self) -> Result<u32>

Returns the current baud rate.

fn data_bits(&self) -> Result<DataBits>

Returns the character size.

fn parity(&self) -> Result<Parity>

Returns the parity-checking mode.

fn stop_bits(&self) -> Result<StopBits>

Returns the number of stop bits.

fn flow_control(&self) -> Result<FlowControl>

Returns the flow control mode.

fn timeout(&self) -> Duration

Returns the current timeout.

fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()>

Sets the baud rate.

fn set_data_bits(&mut self, data_bits: DataBits) -> Result<()>

Sets the character size.

fn set_parity(&mut self, parity: Parity) -> Result<()>

Sets the parity-checking mode.

fn set_stop_bits(&mut self, stop_bits: StopBits) -> Result<()>

Sets the number of stop bits.

fn set_flow_control(&mut self, _flow_control: FlowControl) -> Result<()>

Sets the flow control mode.

fn write_request_to_send(&mut self, value: bool) -> Result<()>

Sets the state of the RTS (Request To Send) control signal.

fn write_data_terminal_ready(&mut self, value: bool) -> Result<()>

Writes to the Data Terminal Ready pin

fn set_break(&self) -> Result<()>

Start transmitting a break

fn clear_break(&self) -> Result<()>

Stop transmitting a break

impl UsbSerial for CdcSerial

fn configure(&mut self, conf: &SerialConfig) -> Result<()>

Sets baudrate, parity check mode, data bits and stop bits.

fn into_queues(self) -> (Queue<RequestBuffer>, Queue<Vec<u8>>)

Takes nusb transfer queues of the read endpoint and the write endpoint. This can be called after serial configuration to do asynchronous operations.

impl Write for CdcSerial

fn flush(&mut self) -> Result<()>

Does nothing.

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

Writes a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.