Skip to main content

pamoja_store_pop

Function pamoja_store_pop 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_store_pop( store: *mut PamojaStore, out_record: *mut *mut PamojaBuffer, ) -> PamojaStatus
Expand description

Removes and returns the oldest record.

§Arguments

  • store - the buffer.
  • out_record - receives a buffer handle, or null when the store is empty.

§Returns

PamojaStatus::Ok on success. A null out_record with an Ok status means the buffer is empty.

§Safety

store must be a live handle and out_record must be writable.