embassy-usb

Crates

git

Versions

default

Flavors

Skip to main content

MidiClassConfig

Struct MidiClassConfig 

Source
#[non_exhaustive]
pub struct MidiClassConfig<'d> { pub n_in_jacks: u8, pub n_out_jacks: u8, pub max_packet_size: u16, pub interface_name: Option<&'d str>, pub in_jack_names: &'d [Option<&'d str>], pub out_jack_names: &'d [Option<&'d str>], pub midi2: Option<Midi2Config<'d>>, }
Expand description

Configuration for the MIDI class.

For the jacks, the field names use the terminology used by the USB specification, which defines the direction from the perspective of the host.

This struct also implements the Default trait with the most common setup: 1 input jack, 1 output jack and a maximum packet size of 64.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§n_in_jacks: u8

Number of jacks for sending data to the host via the IN endpoint. If set to 0, the IN endpoint will not be allocated.

§n_out_jacks: u8

Number of jacks for receiving data from the host via the OUT endpoint. If set to 0, the OUT endpoint will not be allocated.

§max_packet_size: u16

Maximum packet size for the endpoints.

The same bulk endpoints are used by the MIDI 1.0 and MIDI 2.0 alternate settings, so this single value applies to both. At full speed, the value has to be one of 8, 16, 32 or 64. At high speed it has to be 512, and at SuperSpeed 1024. MidiClass::new and MidiClass::new_with_names panic otherwise.

The default is 64, so a high-speed device has to set it.

§interface_name: Option<&'d str>

Name of the MIDIStreaming interface.

§in_jack_names: &'d [Option<&'d str>]

Name of each IN jack.

§out_jack_names: &'d [Option<&'d str>]

Name of each OUT jack.

§midi2: Option<Midi2Config<'d>>

Optional MIDI 2.0 configuration for Alternate Setting 1.

When set, Alternate Setting 1 reuses the bulk endpoints of Alternate Setting 0 instead of allocating a second pair.

Trait Implementations§

Source§

impl<'d> Clone for MidiClassConfig<'d>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'d> Debug for MidiClassConfig<'d>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MidiClassConfig<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'d> Format for MidiClassConfig<'d>
where Option<&'d str>: Format, &'d [Option<&'d str>]: Format, Option<Midi2Config<'d>>: Format,

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

Auto Trait Implementations§

§

impl<'d> Forget for MidiClassConfig<'d>

§

impl<'d> Freeze for MidiClassConfig<'d>

§

impl<'d> Move for MidiClassConfig<'d>

§

impl<'d> RefUnwindSafe for MidiClassConfig<'d>

§

impl<'d> Send for MidiClassConfig<'d>

§

impl<'d> Sync for MidiClassConfig<'d>

§

impl<'d> Unpin for MidiClassConfig<'d>

§

impl<'d> UnsafeUnpin for MidiClassConfig<'d>

§

impl<'d> UnwindSafe for MidiClassConfig<'d>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.