Enum PollError 

#[non_exhaustive]
pub enum PollError {
    Malformed {
        path: Utf8PathBuf,
        contents: Vec<u8>,
        source: Box<dyn Error + Send + Sync>,
    },
    Io {
        path: Utf8PathBuf,
        source: Error,
    },
    ProcessExited {
        path: Utf8PathBuf,
        status: ExitStatus,
    },
    ChildTryWait {
        path: Utf8PathBuf,
        source: Error,
    },
}

A permanent error indicating the port file could not be read, returned by poll_once.

This is also part of the WaitForError::Poll variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Malformed

The file was present but its contents could not be parsed.

When the file is produced by write or another atomic writer, there is no danger of seeing a partial write, so a parse error is permanent. However, a non-atomic writer can momentarily expose an incomplete file, which would be reported as malformed here.

Fields

path: Utf8PathBuf

The path to the port file.

contents: Vec<u8>

The raw contents of the port file read from disk.

source: Box<dyn Error + Send + Sync>

The error describing why the contents could not be parsed.

For a value that was present but unparseable, this is the error returned by the FromStr implementation. It could also be an error indicating a missing trailing newline or invalid UTF-8.

Io

The file could not be read for a reason other than “not found yet” or an interrupted read.

Io is returned for all I/O error kinds other than the following:

• io::ErrorKind::NotFound, since that indicates the port file is not present.
• io::ErrorKind::Interrupted, which should be retried.
• On Windows, OS error 32 (ERROR_SHARING_VIOLATION), which usually indicates an antivirus or other scanner.

Fields

path: Utf8PathBuf

The path to the port file.

source: Error

The error that occurred while reading the port file.

ProcessExited

The child process exited before the port file appeared.

Fields

path: Utf8PathBuf

The path to the port file.

status: ExitStatus

The exit status of the child process.

ChildTryWait

There was an error determining whether the child process was alive.

Fields

path: Utf8PathBuf

The path to the port file.

source: Error

The error that occurred while trying to wait for the child process.

Implementations

impl PollError

pub fn path(&self) -> &Utf8Path

Returns the path to the port file.

Trait Implementations

impl Debug for PollError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PollError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for PollError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.