Browse Source

Explain the `username` parameter on `Uds::new()`

pull/156/head
Jhynjhiruu 11 months ago
parent
commit
1cdf4737f2
  1. 3
      ctru-rs/src/services/uds.rs

3
ctru-rs/src/services/uds.rs

@ -253,6 +253,9 @@ impl Uds {
/// No `new_with_buffer_size` function is provided, as there isn't really a /// No `new_with_buffer_size` function is provided, as there isn't really a
/// reason to use any size other than the default. /// 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 /// # Errors
/// ///
/// This function will return an error if the [`Uds`] service is already being used, /// This function will return an error if the [`Uds`] service is already being used,

Loading…
Cancel
Save