Struct UsbMscHandler 

pub struct UsbMscHandler { /* private fields */ }

USB Mass Storage Class handler implementing BOT protocol

Debug is required by usbip::UsbInterfaceHandler as of 0.9. Derived rather than hand-written: none of the fields is a secret, and the disk image behind the Mutex prints as a handle, not as its contents.

Implementations

impl UsbMscHandler

pub fn new(disk_image: SharedDisk, write_protect: bool) -> Self

Create new MSC handler with disk image

pub fn with_io_events(self, io_tx: UnboundedSender<MscIoEvent>) -> Self

Report completed transfers on io_tx so the connection task can raise events.

pub fn set_write_protect(&mut self, enabled: bool)

Set write-protect flag

When enabled, WRITE(10) commands will fail with DATA_PROTECT sense.

pub fn is_write_protected(&self) -> bool

Get current write-protect status

pub fn mount_disk(&mut self, new_disk: SharedDisk)

Replace the disk image with a new one

This allows mounting a different disk image at runtime.

pub fn eject_disk(&mut self)

Eject the current disk (simulates media removal)

After ejection every command that needs the medium fails with NOT_READY until a new disk is mounted. Setting sense alone was not enough: the very next command cleared it, so an ejected device kept happily serving sectors.

pub fn is_medium_present(&self) -> bool

Whether a medium is currently present.

pub fn get_disk_info(&self) -> Option<(u32, u32)>

Get disk capacity info as (total_sectors, bytes_per_sector).

Trait Implementations

impl Debug for UsbMscHandler

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

Formats the value using the given formatter.

impl UsbInterfaceHandler for UsbMscHandler

Available on Unix and crate feature libusb only.

fn handle_urb( &mut self, _interface: &UsbInterface, endpoint: UsbEndpoint, transfer_buffer_length: u32, setup: SetupPacket, data: &[u8], ) -> Result<Vec<u8>, Error>

Handle a URB(USB Request Block) targeting at this interface

fn get_class_specific_descriptor(&self) -> Vec<u8>

Return the class specific descriptor which is inserted between interface descriptor and endpoint descriptor

fn as_any(&mut self) -> &mut dyn Any

Helper to downcast to actual struct