Struct yaque::queue::ReceiverBuilder
source · pub struct ReceiverBuilder { /* private fields */ }
Expand description
A builder for the receiver side of the queue. Use this if you want to have fine-grained control over the configuration of the queue. Most defaults should be ok of most applications.
Implementations§
source§impl ReceiverBuilder
impl ReceiverBuilder
pub fn new() -> ReceiverBuilder
sourcepub fn save_every_nth(self, nth: Option<usize>) -> ReceiverBuilder
pub fn save_every_nth(self, nth: Option<usize>) -> ReceiverBuilder
Sets the receiver to save its state to the disk at every n-th element.
Set it to None
to disable this policy.
Default value: every 250 elements.
sourcepub fn save_every(self, duration: Option<Duration>) -> ReceiverBuilder
pub fn save_every(self, duration: Option<Duration>) -> ReceiverBuilder
Sets the receiver to save ir state to the disk at every given interval
of time. Set it to None
to disable this policy.
Default value: every 350 milliseconds.
Note:
This policy is enforced synchronously. This means that there is no asynchronous behavior involved (i.e. timers). This condition will only be checked when a new element is pushed to the queue.
sourcepub fn open<P: AsRef<Path>>(self, base: P) -> Result<Receiver>
pub fn open<P: AsRef<Path>>(self, base: P) -> Result<Receiver>
Opens a queue for reading. The access will be exclusive, based on the
existence of the temporary file recv.lock
inside the queue folder.
Errors
This function will return an IO error if the queue is already in use for receiving, which is indicated by a lock file. Also, any other IO error encountered while opening will be sent.
Panics
This function will panic if it is not able to set up the notification handler to watch for file changes.