From 1cdf4737f2f94f5c74d28a7f4a863e459b3247e5 Mon Sep 17 00:00:00 2001 From: Jhynjhiruu Date: Thu, 8 Feb 2024 21:59:16 +0000 Subject: [PATCH] Explain the `username` parameter on `Uds::new()` --- ctru-rs/src/services/uds.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ctru-rs/src/services/uds.rs b/ctru-rs/src/services/uds.rs index 8b6caf0..ae4decc 100644 --- a/ctru-rs/src/services/uds.rs +++ b/ctru-rs/src/services/uds.rs @@ -252,6 +252,9 @@ impl Uds { /// Initialise a new service handle. /// No `new_with_buffer_size` function is provided, as there isn't really a /// reason to use any size other than the default. + /// + /// The `username` parameter should be a max 10-byte (not 10 code point!) UTF-8 string, converted to UTF-16 internally. + /// Pass `None` to use the 3DS's configured username. /// /// # Errors ///