Struct lv2rs_atom::frame::RootFrame

pub struct RootFrame<'a, A: AtomBody + ?Sized> { /* fields omitted */ }

The ground level writing frame.

This writing frame manages the first atom and actually has access to the data. It is created by the AtomOutputPort and simply acts like any WritingFrame.

Methods

impl<'a, A: AtomBody + ?Sized> RootFrame<'a, A>

pub fn new(free_space: &'a mut [u8], urids: &mut CachedMap) -> Result<Self, ()>

Try to create a new root frame.

All you need to create a root frame is a slice of writable memory and a way to retrieve the URID of the managed atom. Then, this function will initialize the header in the beginning of the slice and create the frame.

If the slice is not big enough to hold the atom header, this function returns an Err.

Trait Implementations

impl<'a, A: AtomBody + ?Sized> WritingFrame<'a> for RootFrame<'a, A>

unsafe fn write_raw(&mut self, data: &[u8]) -> Result<&'a mut [u8], ()>

Try to write out a slice of bytes into the atom space.

fn get_atom(&self) -> &Atom

Return an immutable reference to the managed atom header.

impl<'a, A: AtomBody + ?Sized> WritingFrameExt<'a, A> for RootFrame<'a, A>

unsafe fn write_sized<T: Sized>(&mut self, object: &T) -> Result<&'a mut T, ()>

Try to write a sized object into the atom space.

unsafe fn create_nested_frame<'b, C: AtomBody + ?Sized>(
    &'b mut self,
    urids: &mut CachedMap
) -> Result<NestedFrame<'b, 'a, C>, ()>

Create a new atom header and return a nested writing frame for it.

unsafe fn get_atom_body<'b>(
    &'b self,
    urids: &mut CachedMap
) -> Result<&'b A, GetBodyError>

Try to get a reference to the body from our atom header.