Module sequential_storage::queue

A queue (fifo) implementation for storing arbitrary data in flash memory.

Use push to add data to the fifo and use peek and pop to get the data back.

// Initialize the flash. This can be internal or external
let mut flash = Flash::default();
// These are the flash addresses in which the crate will operate.
// The crate will not read, write or erase outside of this range.
let flash_range = 0x1000..0x3000;
// We need to give the crate a buffer to work with.
// It must be big enough to serialize the biggest value of your storage type in.
let mut data_buffer = [0; 100];

let my_data = [10, 47, 29];

// We can push some data to the queue

push(&mut flash, flash_range.clone(), &my_data, false).unwrap();

// We can peek at the oldest data

assert_eq!(
    &peek(&mut flash, flash_range.clone(), &mut data_buffer).unwrap().unwrap()[..],
    &my_data[..]
);

// With popping we get back the oldest data, but that data is now also removed

assert_eq!(
    &pop(&mut flash, flash_range.clone(), &mut data_buffer).unwrap().unwrap()[..],
    &my_data[..]
);

// If we pop again, we find there's no data anymore

assert_eq!(
    pop(&mut flash, flash_range.clone(), &mut data_buffer),
    Ok(None)
);

Structs

• PeekIterator
  Iterator for peek’ing elements in the queue.
• PopIterator
  Iterator for pop’ing elements in the queue.

Functions

• find_max_fit
  Find the largest size of data that can be stored.
• peek
  Peek at the oldest data.
• peek_many
  Peek at the data from oldest to newest.
• pop
  Pop the oldest data from the queue.
• pop_many
  Pop the data from oldest to newest.
• push
  Push data into the queue in the given flash memory with the given range. The data can only be taken out with the pop function.