IoError structv0.1.0

pub struct IoError {
    pub kind: IoErrorKind;
    pub raw: int32;
}

Copy. The raw field is errno on the Unix systems and the Win32 error code on Windows, kept because translation loses detail and the detail is sometimes the diagnosis.

Fields

Associated functions

Of

pub func Of(kind: IoErrorKind) -> IoError

A failure of kind with no platform code.

Returns: an error of that kind, carrying no platform value

Source

Methods

IsEnd

pub func IsEnd(self: &IoError) -> bool

Whether the stream ended, which is the one report that is not a failure.

Returns: whether the stream ended, which is not a failure

Source

IsTransient

pub func IsTransient(self: &IoError) -> bool

Whether going again is the right response: an interruption or a would-block.

Returns: whether trying again could succeed

Source

Implements Display

IoError conforms to Display.

WriteDisplay

pub func WriteDisplay(
    self: &IoError,
    writer: &var TextWriter,
    spec: FormatSpec
) -> ! FormatError

Writes the kind as lower-case words, and the platform's code after them when there is one, as not found (os error 2), under the placeholder's width, fill and alignment. No style is understood. Reports whatever the writer reported, and UnsupportedRequest for a style.

Returns: success when the whole text was accepted

Source

Related

IoErrorKind

pub enum IoErrorKind: int32 {
    EndOfStream = 1,
    NotFound = 2,
    PermissionDenied = 3,
    AlreadyExists = 4,
    IsDirectory = 5,
    NotDirectory = 6,
    StorageFull = 7,
    Interrupted = 8,
    WouldBlock = 9,
    InvalidHandle = 10,
    InvalidInput = 11,
    TimedOut = 12,
    WriteZero = 13,
    InvalidText = 15,
    LimitExceeded = 16,
    ConnectionRefused = 17,
    ConnectionReset = 18,
    ConnectionAborted = 19,
    NotConnected = 20,
    AddressInUse = 21,
    AddressUnavailable = 22,
    Unreachable = 23,
    BrokenPipe = 24,
    Other = 14
}

What an I/O operation reported.

Source

Cases

Implements Display

IoErrorKind conforms to Display.

WriteDisplay

pub func WriteDisplay(
    self: &IoErrorKind,
    writer: &var TextWriter,
    spec: FormatSpec
) -> ! FormatError

Writes the kind as lower-case words, such as not found, under the placeholder's width, fill and alignment. No style is understood. Reports whatever the writer reported, and UnsupportedRequest for a style.

Returns: success when the whole text was accepted

Source

FromIoError

pub func FromIoError(outcome: ! IoError) -> ! FormatError

Turns what a stream reported into what a formatter understands. Success becomes the formatter's success value; every failure becomes WriterFailure, which is the only thing FormatError can say about a destination. The details do not travel this way — an adapter records the original IoError where its caller can read it, which is what keeps the loss from being a loss. The end of a stream is a failure here. Nothing is being read, so a write that reports it is a destination that cannot take the bytes, whatever it calls that.

Source

Parameters

Returns: success for a success, and WriterFailure for any failure

ToIoError

pub func ToIoError(error: &FormatError) -> IoError

Turns a formatting failure into something a stream's caller can act on. The distinction that survives is the one worth having: a request that was wrong is InvalidInput and will be wrong again, while a destination that failed came back as an IoError in the first place and never reaches here. Bytes that were not text are InvalidText; a bounded destination that filled is LimitExceeded. WriterFailure should not arrive: an adapter records the stream's own error and its caller reports that instead. It maps to Other rather than being ignored, so an adapter that forgets to keep the original is visibly wrong rather than quietly reporting success.

Source

Parameters

Returns: the closest I/O meaning, with no platform code, since none applies