1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
//! Homogenous array of sized atoms. //! //! A [vector](type.Vector.html) is the LV2 equivalent of a slice: It has a variable length, but it //! does only contain one type of item, which has to be sized. //! //! When initialized, a vector does not contain any items. These items have to be pushed or appended //! to the vector using the [`VectorWritingFrame`](trait.VectorWritingFrame.html) trait. Every //! writing frame implements this trait via a blanket implementation and the trait is included in //! the crate's prelude. You can, therefore, act as if the extended methods were normal methods of a //! writing frame. //! //! Reading the vector is done using these methods: //! * [`child_body_size`](type.Vector.html#method.child_body_size) //! * [`child_body_type`](type.Vector.html#method.child_body_type) //! * [`as_slice`](type.Vector.html#method.as_slice) //! //! An example: //! //! extern crate lv2rs_atom as atom; //! extern crate lv2rs_urid as urid; //! //! use atom::prelude::*; //! use atom::ports::*; //! use urid::{CachedMap, debug::DebugMap}; //! use std::ffi::CStr; //! //! pub struct Plugin { //! in_port: AtomInputPort<Vector<f32>>, //! out_port: AtomOutputPort<Vector<f32>>, //! urids: CachedMap, //! } //! //! impl Plugin { //! /// Simulated `run` method. //! fn run(&mut self) { //! // Writing //! { //! let mut frame = //! unsafe { self.out_port.write_atom_body(&(), &mut self.urids) }.unwrap(); //! frame.push(0.0).unwrap(); //! frame.append(&[1.0, 2.0, 3.0, 4.0]).unwrap(); //! } //! //! // Reading. //! let vector = unsafe { self.in_port.get_atom_body(&mut self.urids) }.unwrap(); //! assert_eq!([0.0, 1.0, 2.0, 3.0, 4.0], vector.as_slice()); //! } //! } //! //! // Getting a debug URID map. //! let mut debug_map = DebugMap::new(); //! let mut urids = unsafe {debug_map.create_cached_map()}; //! //! // Creating the plugin. //! let mut plugin = Plugin { //! in_port: AtomInputPort::new(), //! out_port: AtomOutputPort::new(), //! urids: urids, //! }; //! //! // Creating the atom space. //! let mut atom_space = vec![0u8; 256]; //! let atom = unsafe { (atom_space.as_mut_ptr() as *mut Atom).as_mut() }.unwrap(); //! *(atom.mut_size()) = 256 - 8; //! //! // Connecting the ports. //! plugin.in_port.connect_port(atom as &Atom); //! plugin.out_port.connect_port(atom); //! //! // Calling `run`. //! plugin.run(); use crate::atom::{array::*, *}; use crate::frame::{WritingFrame, WritingFrameExt}; use crate::uris; use std::ffi::CStr; use std::mem::size_of; use std::os::raw::*; use urid::URID; /// The body header of a vector. /// /// It contains the size of the child type (which has to be static) and the child type itself. /// This struct is also `repr(C)` and is used to interpret raw atom data. #[repr(C)] pub struct VectorHeader { pub child_size: c_uint, pub child_type: c_uint, } /// A homogenous array of sized atoms. /// /// See the [module documentation](index.html) for more information. pub type Vector<T> = ArrayAtomBody<VectorHeader, T>; impl ArrayAtomHeader for VectorHeader { type InitializationParameter = URID; unsafe fn initialize<'a, W, T>( writer: &mut W, child_type: &URID, _urids: &mut urid::CachedMap, ) -> Result<(), ()> where T: 'static + Sized + Copy, ArrayAtomBody<Self, T>: AtomBody, W: WritingFrame<'a> + WritingFrameExt<'a, ArrayAtomBody<Self, T>>, { let header = VectorHeader { child_size: size_of::<T>() as u32, child_type: *child_type, }; writer.write_sized(&header)?; Ok(()) } } impl<T> AtomBody for Vector<T> where T: 'static + AtomBody + Sized + Copy, { type InitializationParameter = (); fn get_uri() -> &'static CStr { unsafe { CStr::from_bytes_with_nul_unchecked(uris::VECTOR_TYPE_URI) } } unsafe fn initialize_body<'a, W>( writer: &mut W, _: &(), urids: &mut urid::CachedMap, ) -> Result<(), ()> where W: WritingFrame<'a> + WritingFrameExt<'a, Self>, { Self::__initialize_body(writer, &urids.map(T::get_uri()), urids) } fn create_ref<'a>(raw_data: &'a [u8]) -> Result<&'a Self, ()> { Self::__create_ref(raw_data) } } impl<T> Vector<T> where T: 'static + AtomBody + Sized + Copy, { /// Return the size of the child type, according to the vector's body header. pub fn child_body_size(&self) -> usize { self.header.child_size as usize } /// Return the type of the child, according to the vector's body header. pub fn child_body_type(&self) -> URID { self.header.child_type } /// Return a slice containing all items in the vector. /// /// No allocation is done; This method simply borrows the data of the vector. pub fn as_slice(&self) -> &[T] { &self.data } } /// Extension for [`WritingFrame`](../frame/trait.WritingFrame.html) and /// [`WritingFrameExt`](../frame/trait.WritingFrameExt.html) for vectors. /// /// See the [module documentation](index.html) for more information. pub trait VectorWritingFrame<'a, T> where T: 'static + AtomBody + Sized + Copy, Self: WritingFrame<'a> + WritingFrameExt<'a, Vector<T>>, { /// Push a value to the end of the vector. fn push(&mut self, value: T) -> Result<(), ()> { unsafe { Vector::<T>::push(self, value) } } /// Append a slice of values to the end of the vector. fn append(&mut self, slice: &[T]) -> Result<(), ()> { unsafe { Vector::<T>::append(self, slice) } } } impl<'a, T, F> VectorWritingFrame<'a, T> for F where T: 'static + AtomBody + Sized + Copy, F: WritingFrame<'a> + WritingFrameExt<'a, Vector<T>>, { }