Struct PortReader

pub struct PortReader<'a> { /* private fields */ }

A handle to read atoms from a port.

If you add an AtomPort to your ports struct, you will receive an instance of this struct to read atoms.

Implementations

impl<'a> PortReader<'a>

pub fn read<'b, A: Atom<'a, 'b>>( &'b self, urid: URID<A>, parameter: A::ReadParameter, ) -> Option<A::ReadHandle>

Read an atom.

In order to identify the atom, the reader needs to know it’s URID. Also, some atoms require a parameter. However, you can simply pass () in most cases.

This method returns None if the atom is malformed or simply isn’t of the specified type.