Struct chronicle::queue::BytesReader

#[repr(C)]
pub struct BytesReader { /* private fields */ }

A BytesReader enables a reader to directly access bytes within a reserved section written by a BytesWriter. In some cases this can result in reduced read latency by eliminating a copy. It also enables Queue to be directly integrated with components which read directly from a region of memory.

Example

let tailer = queue.create_tailer().unwrap();
{
    let reader = tailer.scoped_bytes_reader();

    if !reader.is_empty() {
        let slice = reader.as_slice();
        ...
        // directly read from the slice (which reads directly from the Queue)
        ...
    }
}

Implementations

impl BytesReader

pub fn as_slice(&self) -> &[u8]

Get a slice to the reserved section of the Queue as a &[u8]

impl BytesReader

pub fn is_empty(&self) -> bool

Test if this BytesReader is invalid (returns true), or has available content (returns false)

As an equivalent check, the slice returned by as_slice will have 0 length if the BytesReader is empty

impl BytesReader

pub fn rollback_on_close(&self)

Set this BytesReader to rollback when closed (either explicitly by calling close(), or automatically when using a scoped reader). Rolling back leaves the reader in the same state and read position as before the read was attempted

Trait Implementations

impl Closeable for BytesReader

fn close(&self)

impl ExternType for BytesReader

type Kind = Opaque

Either cxx::kind::Opaque or cxx::kind::Trivial.

type Id

A type-level representation of the type’s C++ namespace and type name.