Struct libuv::handles::fs_poll::FsPollHandle

pub struct FsPollHandle { /* fields omitted */ }

FS Poll handles allow the user to monitor a given path for changes. Unlike FsEventHandle, fs poll handles use stat to detect when a file has changed so they can work on file systems where fs event handles can’t.

Implementations

impl FsPollHandle

pub fn new(r#loop: &Loop) -> Result<FsPollHandle>

Create and initialize a new fs poll handle

pub fn start<CB: Into<FsPollCB<'static>>>(
    &mut self,
    path: &str,
    interval: u32,
    cb: CB
) -> Result<(), Box<dyn Error>>

Check the file at path for changes every interval milliseconds.

Note: For maximum portability, use multi-second intervals. Sub-second intervals will not detect all changes on many file systems.

pub fn stop(&mut self) -> Result<()>

Stop the handle, the callback will no longer be called.

pub fn getpath(&self) -> Result<String>

Get the path being monitored by the handle.

Trait Implementations

impl Clone for FsPollHandle

fn clone(&self) -> FsPollHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FsPollHandle

impl From<FsPollHandle> for Handle

fn from(fs_poll: FsPollHandle) -> Handle

Performs the conversion.

impl HandleTrait for FsPollHandle

fn is_active(&self) -> bool

Returns non-zero if the handle is active, zero if it’s inactive. What “active” means depends on the type of handle: * An AsyncHandle is always active and cannot be deactivated, except by closing it with close(). * A PipeHandle, TcpHandle, UdpHandle, etc. - basically any handle that deals with i/o - is active when it is doing something that involves i/o, like reading, writing, connecting, accepting new connections, etc. * A CheckHandle, IdleHandle, TimerHandle, etc. is active when it has been started with a call to start().

fn is_closing(&self) -> bool

Returns non-zero if the handle is closing or closed, zero otherwise.

fn close<CB: Into<CloseCB<'static>>>(&mut self, cb: CB)

Request handle to be closed. close_cb will be called asynchronously after this call. This MUST be called on each handle before memory is released. Moreover, the memory can only be released in close_cb or after it has returned.

fn ref(&mut self)

Reference the given handle. References are idempotent, that is, if a handle is already referenced calling this function again will have no effect.

fn unref(&mut self)

Un-reference the given handle. References are idempotent, that is, if a handle is not referenced calling this function again will have no effect.

fn has_ref(&self) -> bool

Returns true if the handle referenced, zero otherwise.

fn send_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the send buffer that the operating system uses for the socket.

fn recv_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the receive buffer that the operating system uses for the socket.

fn get_fileno(&self) -> Result<OsFile>

Gets the platform dependent file descriptor equivalent.

fn get_loop(&self) -> Loop

Returns the Loop associated with this handle.

fn get_type(&self) -> HandleType

Returns the type of the handle.

impl ToHandle for FsPollHandle

fn to_handle(&self) -> Handle

impl TryFrom<Handle> for FsPollHandle

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(handle: Handle) -> Result<Self, Self::Error>

Performs the conversion.