Some more docs

Author: prokopyl

options/src/extensions.rs

@@ -1,5 +1,4 @@
 //! Contains the [`OptionsInterface`](crate::extensions::OptionsInterface) extension interface.
-
 use crate::features::OptionsList;
 use crate::{OptionsError, OptionsWriter};
 use lv2_core::feature::Feature;
@@ -12,6 +11,100 @@ use std::panic::AssertUnwindSafe;
 use urid::UriBound;
 
 /// An interface to allow dynamically setting options from the host.
+///
+/// # Example
+///
+///
+///
+/// ```
+/// # use lv2_core::prelude::*;
+/// # use lv2_options::{OptionType, OptionsWriter, OptionsError, Subject};
+/// # use lv2_options::features::OptionsList;
+/// # use lv2_options::extensions::{OptionsDescriptor, OptionsInterface};
+/// #
+/// # use urid::{URID, Uri};
+/// # use std::any::Any;
+/// #
+/// # impl<'a> OptionType<'a> for SomeIntOption {
+/// #    type AtomType = lv2_atom::scalar::Int;
+/// #
+/// # fn from_option_value(value: &i32) -> Option<Self> {
+/// #        Some(Self(*value))
+/// #    }
+/// #
+/// #    fn as_option_value(&'a self) -> &'a i32 {
+/// #        &self.0
+/// #    }
+/// # }
+/// #
+/// # #[derive(URIDCollection)]
+/// pub struct PluginUridCollection {
+///     some_int_option: URID<SomeIntOption>,
+///     int: URID<lv2_atom::scalar::Int>,
+/// }
+/// #
+/// # #[derive(FeatureCollection)]
+/// # pub struct PluginFeatures<'a> {
+/// #    options: OptionsList<'a>,
+/// # }
+///
+/// # #[uri("urn:lv2_options:test:OptionablePlugin")]
+/// pub struct OptionablePlugin {
+///     some_int: SomeIntOption,
+///     urids: PluginUridCollection,
+/// }
+/// #
+/// # impl Plugin for OptionablePlugin {
+///     # type Ports = ();
+///     # type InitFeatures = PluginFeatures<'static>;
+///     # type AudioFeatures = ();
+///    #
+///     # fn new(_plugin_info: &PluginInfo, _features: &mut Self::InitFeatures) -> Option<Self> {
+/// #        unimplemented!()
+/// #    }
+///#
+/// #    fn run(
+///  #       &mut self,
+///  #       _ports: &mut Self::Ports,
+///  #       _features: &mut Self::AudioFeatures,
+///  #       _sample_count: u32,
+///  #   ) {
+///  #       unimplemented!()
+///  #   }
+///  #
+///  #   fn extension_data(uri: &Uri) -> Option<&'static dyn Any> {
+///  #       unimplemented!()
+///  #   }
+/// # }
+/// #
+///
+/// #[uri("urn:lv2_options:test:SomeIntOption")]
+/// pub struct SomeIntOption(i32);
+///
+/// impl OptionsInterface for OptionablePlugin {
+///    fn get<'a>(&'a self, mut writer: OptionsWriter<'a>) -> Result<(), OptionsError> {
+///         writer.process(|subject, options| match subject { // We will want to get/set our opions differently depending on the subject
+///             Subject::Instance => { // In our case however, only our instance has an option
+///                 options.handle(self.urids.some_int_option, self.urids.int, || {
+///                     &self.some_int
+///                 });
+///             }
+///             _ => {}
+///         })
+///     }
+///
+///     fn set(&mut self, options: OptionsList) -> Result<(), OptionsError> {
+///         options.process(|subject, options| match subject {
+///             Subject::Instance => {
+///                 options.handle(self.urids.some_int_option, self.urids.int, (), |value| {
+///                     self.some_int = value
+///                 })
+///             }
+///             _ => {}
+///         })
+///     }
+/// }
+/// ```
 pub trait OptionsInterface: Plugin {
     /// Allows the host to retrieve the value of the given options, as currently stored by the plugin.
     ///

options/tests/optionable.rs

@@ -38,13 +38,9 @@ pub struct PluginFeatures<'a> {
     options: OptionsList<'a>,
 }
 
-pub struct PluginOptions {
-    some_int: SomeIntOption,
-}
-
 #[uri("urn:lv2_options:test:OptionablePlugin")]
 pub struct OptionablePlugin {
-    options: PluginOptions,
+    some_int: SomeIntOption,
     urids: PluginUridCollection,
 }
 
@@ -55,9 +51,7 @@ impl Plugin for OptionablePlugin {
 
     fn new(_plugin_info: &PluginInfo, features: &mut Self::InitFeatures) -> Option<Self> {
         let mut plugin = OptionablePlugin {
-            options: PluginOptions {
-                some_int: SomeIntOption(0),
-            },
+            some_int: SomeIntOption(0),
             urids: features.map.populate_collection()?,
         };
 
@@ -86,7 +80,7 @@ impl OptionsInterface for OptionablePlugin {
         writer.process(|subject, options| match subject {
             Subject::Instance => {
                 options.handle(self.urids.some_int_option, self.urids.int, || {
-                    &self.options.some_int
+                    &self.some_int
                 });
             }
             _ => {}
@@ -97,7 +91,7 @@ impl OptionsInterface for OptionablePlugin {
         options.process(|subject, options| match subject {
             Subject::Instance => {
                 options.handle(self.urids.some_int_option, self.urids.int, (), |value| {
-                    self.options.some_int = value
+                    self.some_int = value
                 })
             }
             _ => {}