Struct QueueFile 

pub struct QueueFile { /* private fields */ }

Implementations

impl QueueFile

pub fn with_capacity<P: AsRef<Path>>( path: P, capacity: u64, ) -> Result<Self, Error>

Opens or creates a QueueFile at path with the given initial file size.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Opens or creates a QueueFile at path using v2 format with a 4 KiB initial file size.

pub fn open_legacy<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Opens or creates a QueueFile at path using the legacy (16-byte) header format.

pub const fn overwrite_on_remove(&self) -> bool

pub const fn get_overwrite_on_remove(&self) -> bool

👎Deprecated since 1.4.7:

Use overwrite_on_remove instead.

pub fn set_overwrite_on_remove(&mut self, value: bool)

pub const fn sync_writes(&self) -> bool

pub const fn get_sync_writes(&self) -> bool

👎Deprecated since 1.4.7:

Use sync_writes instead.

pub fn set_sync_writes(&mut self, value: bool)

pub const fn skip_write_header_on_add(&self) -> bool

pub const fn get_skip_write_header_on_add(&self) -> bool

👎Deprecated since 1.4.7:

Use skip_write_header_on_add instead.

pub fn set_skip_write_header_on_add(&mut self, value: bool)

pub const fn cache_offset_policy(&self) -> Option<OffsetCacheKind>

pub const fn get_cache_offset_policy(&self) -> Option<OffsetCacheKind>

👎Deprecated since 1.4.7:

Use cache_offset_policy instead.

pub fn set_cache_offset_policy( &mut self, kind: impl Into<Option<OffsetCacheKind>>, )

pub const fn is_empty(&self) -> bool

pub const fn size(&self) -> usize

pub fn sync_all(&mut self) -> Result<(), Error>

pub fn add_n( &mut self, elems: impl IntoIterator<Item = impl AsRef<[u8]>>, ) -> Result<(), Error>

pub fn add(&mut self, buf: &[u8]) -> Result<(), Error>

pub fn peek(&self) -> Result<Option<Vec<u8>>, Error>

pub fn peek_into(&self, buf: &mut Vec<u8>) -> Result<bool, Error>

pub fn remove(&mut self) -> Result<(), Error>

pub fn remove_n(&mut self, n: usize) -> Result<(), Error>

pub fn clear(&mut self) -> Result<(), Error>

pub const fn iter(&self) -> Iter<'_>

pub const fn file_len(&self) -> u64

pub const fn used_bytes(&self) -> u64

pub fn into_inner_file(self) -> Result<File, Error>

Trait Implementations

impl Debug for QueueFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for QueueFile

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a> IntoIterator for &'a QueueFile

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

type Item = Vec<u8>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.