Struct yaque::Sender

pub struct Sender { /* fields omitted */ }

The sender part of the queue. This part is lock-free and therefore can be used outside an asynchronous context.

Implementations

impl Sender

pub fn open<P: AsRef<Path>>(base: P) -> Result<Sender>

Opens a queue on a folder indicated by the base path for sending. The folder will be created if it does not already exist.

Errors

This function will return an IO error if the queue is already in use for sending, which is indicated by a lock file. Also, any other IO error encountered while opening will be sent.

pub fn send<D: AsRef<[u8]>>(&mut self, data: D) -> Result<()>

Sends some data into the queue. One send is always atomic.

Errors

This function returns any underlying errors encoutered while writing or flushing the queue.

pub fn send_batch<I>(&mut self, it: I) -> Result<()> where
    I: IntoIterator,
    I::Item: AsRef<[u8]>, 

Sends all the contents of an iterable into the queue. All is buffered to be sent atomically, in one flush operation.

Trait Implementations

impl Drop for Sender

fn drop(&mut self)

Executes the destructor for this type.