Struct yaque::queue::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 save(&mut self) -> Result<()>

👎 Deprecated since 0.5.0:

the sender state is always inferred. There is no need to save anything

Saves the sender queue state. You do not need to use method in most circumstances, since it is automatically done on drop (yes, it will be called eve if your thread panics). However, you can use this function to

1. Make periodical backups. Use an external timer implementation for this.

2. Handle possible IO errors in sending. The drop implementation will ignore (but log) any io errors, which may lead to data loss in an unreliable filesystem. It was implmemented this way because no errors are allowed to propagate on drop and panicking will abort the program if drop is called during a panic.

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 encountered 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.

Errors

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