Struct lv2rs_atom::ports::AtomInputPort

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

Wrapper for atom reading operations.

Methods

impl<A: AtomBody + ?Sized> AtomInputPort<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: *const 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 get_atom_body(
    &self,
    urids: &mut CachedMap
) -> Result<&A, GetAtomError>

Dereference the internal raw pointer to an atom body reference.

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!