LV2UI_Request_Value

Struct LV2UI_Request_Value 

Source
#[repr(C)]
pub struct LV2UI_Request_Value { pub handle: LV2UI_Feature_Handle, pub request: Option<unsafe extern "C" fn(handle: LV2UI_Feature_Handle, key: LV2_URID, type_: LV2_URID, features: *const *const LV2_Feature) -> LV2UI_Request_Value_Status>, }
Expand description

A feature to request a new parameter value from the host.

Fields§

§handle: LV2UI_Feature_Handle

Pointer to opaque data which must be passed to request().

§request: Option<unsafe extern "C" fn(handle: LV2UI_Feature_Handle, key: LV2_URID, type_: LV2_URID, features: *const *const LV2_Feature) -> LV2UI_Request_Value_Status>

Request a value for a parameter from the host.

This is mainly used by UIs to request values for complex parameters that don’t change often, such as file paths, but it may be used to request any parameter value.

This function returns immediately, and the return value indicates whether the host can fulfill the request. The host may notify the plugin about the new parameter value, for example when a file is selected by the user, via the usual mechanism. Typically, the host will send a message to the plugin that sets the new parameter value, and the plugin will notify the UI via a message as usual for any other parameter change.

To provide an appropriate UI, the host can determine details about the parameter from the plugin data as usual. The additional parameters of this function provide support for more advanced use cases, but in the simple common case, the plugin will simply pass the key of the desired parameter and zero for everything else.

@param handle The handle field of this struct.

@param key The URID of the parameter.

@param type The optional type of the value to request. This can be used to request a specific value type for parameters that support several. If non-zero, it must be the URID of an instance of rdfs:Class or rdfs:Datatype.

@param features Additional features for this request, or NULL.

@return A status code which is 0 on success.

Trait Implementations§

Source§

impl Clone for LV2UI_Request_Value

Source§

fn clone(&self) -> LV2UI_Request_Value

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LV2UI_Request_Value

Source§

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

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

impl Copy for LV2UI_Request_Value

Auto Trait Implementations§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.