Struct lv2rs_atom::ports::AtomOutputPort

pub struct AtomOutputPort<A: AtomBody + ?Sized> { /* fields omitted */ }

Wrapper for atom writing operations.

Methods

impl<A: AtomBody + ?Sized> AtomOutputPort<A>

pub fn new() -> Self

Create a new port.

Please note that the newly created port wil point to null and therefore, write_atom_body will yield undefined behaviour.

pub fn connect_port(&mut self, atom: *mut Atom)

Set the internal atom pointer.

As implied by the name, this method should be called by an atom's connect_port. However, you have to cast the passed pointer to the correct type!

pub unsafe fn write_atom_body<'a>(
    &'a mut self,
    parameter: &A::InitializationParameter,
    urids: &mut CachedMap
) -> Result<RootFrame<'a, A>, WriteAtomError>

Write an atom to the internal atom pointer.

This method will create a RootFrame and initialize the body. For scalar atoms, this is all you can and need to do. For all other atoms, you can write additional data using the RootFrame.

This method is unsafe since it dereferences the raw, internal pointer and therefore could yield undefined behaviour. Make sure that your plugin's connect_port method calls this port's connect_port method correctly!