Struct SdioClient 

pub struct SdioClient { /* private fields */ }

Available on crate feature clients only.

A TCP Client capable of interacting with an SDIO server.

Implementations

impl SdioClient

pub async fn new( bind_address_control: SocketAddr, bind_address_data: SocketAddr, trace_during_debug: bool, ) -> Result<Self, CatBridgeError>

Create a new SDIO TCP Client.

This will bind listeners, but will not necissarily ensure a client is connected. Most internal methods will ensure a client is connected, but you can

Errors

If we cannot bind to any of the ports we need to bind too.

pub const fn get_response_timeout(&self) -> Duration

pub async fn send_telnet_cafe_os( &self, message: String, ) -> Result<(), CatBridgeError>

Send a telnet message over CafeOS.

This will chunk the message into 499 byte chunks, as that is the maximum amount SDIO protocol can support at once. This may split char boundaries which is probably fine.

Errors

If we cannot send out all of the messages to chunk out on the stream. NOTE that some may still be sent, as it will only be the first error that gets bubbled up.

This may mean prior messages may have been sent out first.

pub async fn send_telnet_dkm( &self, message: String, ) -> Result<(), CatBridgeError>

Send a telnet message over devkitmsg.

This will chunk the message into 499 byte chunks, as that is the maximum amount SDIO protocol can support at once. This may split char boundaries which is probably fine.

Errors

If we cannot send out all of the messages to chunk out on the stream. NOTE that some may still be sent, as it will only be the first error that gets bubbled up.

This may mean prior messages may have been sent out first.

pub async fn send_telnet_sysconfigtool( &self, message: String, ) -> Result<(), CatBridgeError>

Send a telnet message over devkitmsg.

This will chunk the message into 499 byte chunks, as that is the maximum amount SDIO protocol can support at once. This may split char boundaries which is probably fine.

Errors

If we cannot send out all of the messages to chunk out on the stream. NOTE that some may still be sent, as it will only be the first error that gets bubbled up.

This may mean prior messages may have been sent out first.

pub async fn send_raw_telnet_message( &self, messages: Vec<SdioControlTelnetMessage>, ) -> Result<(), CatBridgeError>

Send a series of telnet messages across the telnet channel of this SDIO client.

In general you should probably prefer Self::send_telnet_cafe_os, Self::send_telnet_dkm, Self::send_telnet_sysconfigtool where we just send strings over.

Errors

If we cannot send out all of the messages to chunk out on the stream. NOTE that some may still be sent, as it will only be the first error that gets bubbled up.

This may mean prior messages may have been sent out first.

pub async fn read( &self, lba: u32, blocks: u32, channel: u32, ) -> Result<Bytes, CatBridgeError>

Perform a read request against the remote upstream.

This will read from an address a certain amount of blocks. In real uses the channel is always the same low number, but you may want to perform multi channel reads.

Errors

If we cannot send a request over the Control stream, or if we cannot read a response on the data stream.

Trait Implementations

impl Debug for SdioClient

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

Formats the value using the given formatter.

impl Structable for SdioClient

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl Valuable for SdioClient

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.