IOException

Description

sealed class Tinman.Core.IO.IOException

Derived from: TinmanException

An unexpected I/O error has occurred.

Public / Constructors

BadPath

public static method BadPath → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
invalidPath ⁱⁿ : string: The invalid path string.
returns → IOException: The ready-to-throw exception.

A path string is not valid (e.g. it contains invalid characters).

CannotRead

public static method CannotRead → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: Optional path info value.
returns → IOException: The ready-to-throw exception.

Creates an IOException for an I/O object that does not allow read access.

CannotSeek

public static method CannotSeek → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: Optional path info value.
returns → IOException: The ready-to-throw exception.

Creates an IOException for an I/O object that does not allow random seek access.

CannotWrite

public static method CannotWrite → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: Optional path info value.
returns → IOException: The ready-to-throw exception.

Creates an IOException for an I/O object that does not allow write access.

DataFormatInvalid

_2 overloads

public static method DataFormatInvalid¹ → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
fileFormat ⁱⁿ : string: Name of the binary file format.
message ^opt : string = null: Optional error message.
returns → IOException: The ready-to-throw exception.

Some binary data format is invalid.

public static method DataFormatInvalid² → (4)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
filePath ⁱⁿ : Path: Path to the file.
fileFormat ⁱⁿ : string: Name of the binary file format.
message ^opt : string = null: Optional error message.
returns → IOException: The ready-to-throw exception.

The binary format of the given file is invalid.

DataFormatNotSupported

public static method DataFormatNotSupported → (4)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
filePath ⁱⁿ : Path: Path to the file.
format ⁱⁿ : string: Name of the binary data format.
what ⁱⁿ : string: Describes the feature or version that is not supported.
returns → IOException: The ready-to-throw exception.

A feature or version of a binary data format is not supported.

FileError

_6 overloads

public static method FileError¹ → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
message ⁱⁿ : string: The error message.
returns → IOException: The ready-to-throw exception.

A general filesystem IO error has occurred.

public static method FileError² → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
error ⁱⁿ : int32: The file error code.
message ⁱⁿ : string: The error message.
returns → IOException: The ready-to-throw exception.

A general filesystem IO error has occurred.

public static method FileError³ → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: The file path.
returns → IOException: The ready-to-throw exception.

An I/O error has occurred during a file operation.

Error details are fetched from last OS error code.

public static method FileError⁴ → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: The file path.
error ⁱⁿ : int32: The file error code.
returns → IOException: The ready-to-throw exception.

An I/O error has occurred during a file operation.

public static method FileError⁵ → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
path ⁱⁿ : Path: The file path.
error ⁱⁿ : IOError: The well-known error code.
returns → IOException: The ready-to-throw exception.

An I/O error has occurred during a file operation.

public static method FileError⁶ → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
filePath ⁱⁿ : Path: Path to the file being accessed.
message ⁱⁿ : string: The error message.
returns → IOException: The ready-to-throw exception.

An unexpected IO error has occurred while accessing a file.

MissingPrivilege

public static method MissingPrivilege → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
privilege ⁱⁿ : Privilege: The privilege.
info ⁱⁿ : PrivilegeInfo: The information for which privilege ⁱⁿ has been withheld.
returns → IOException: The ready-to-throw exception.

A required privilege is missing.

NetworkError

_2 overloads

public static method NetworkError¹ → (2)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
message ⁱⁿ : string: The error message.
returns → IOException: The ready-to-throw exception.

An unexpected IO error has occurred while accessing the network.

public static method NetworkError² → (3)

source ⁱⁿ : string: The error source (see TinmanError.ErrorSource).
error ⁱⁿ : int32: The network error code.
message ^opt : string = null: Optional error message.
returns → IOException: The ready-to-throw exception.

An unexpected IO error has occurred while accessing the network.

Public / Methods

MissingPrivilegeMessage

[Pure]
public static method MissingPrivilegeMessage → (2)

privilege ⁱⁿ : Privilege: The privilege.
info ⁱⁿ : PrivilegeInfo: The information for which privilege ⁱⁿ has been withheld.
returns → string: The exception message.

Returns the exception message for: a required privilege is missing.

ThrowIfNoCreate

public static method ThrowIfNoCreate → (1)

obj ⁱⁿ : ICanCreateOpenDelete: [not-null]
The I/O object.

Throws an exception if the given object does not allow creation of new resources.

IOException: See summary.

ThrowIfNoDelete

public static method ThrowIfNoDelete → (1)

obj ⁱⁿ : ICanCreateOpenDelete: [not-null]
The I/O object.

Throws an exception if the given object does not allow deletion of existing resources.

IOException: See summary.

ThrowIfNoOpen

public static method ThrowIfNoOpen → (1)

obj ⁱⁿ : ICanCreateOpenDelete: [not-null]
The I/O object.

Throws an exception if the given object does not allow opening of existing resources.

IOException: See summary.

ThrowIfNoRead

public static method ThrowIfNoRead → (1)

obj ⁱⁿ : ICanReadWrite: [not-null]
The I/O object.

Throws an exception if the given object does not allow read access.

IOException: See summary.

ThrowIfNoSeek

public static method ThrowIfNoSeek → (1)

stream ⁱⁿ : IDataStream: [not-null]
The I/O stream.

Throws an exception if the given stream does not allow random access.

IOException: See summary.

ThrowIfNoWrite

_2 overloads

public static method ThrowIfNoWrite¹ → (1)

obj ⁱⁿ : ICanReadWrite: [not-null]
The I/O object.

Throws an exception if the given object does not allow write access.

IOException: See summary.

public static method ThrowIfNoWrite² → (1)

obj ⁱⁿ : IDataStream: [not-null]
The I/O object.

Throws an exception if the given object does not allow write access.

IOException: See summary.

Public / Attributes

ErrorCode

public attribute ErrorCode → (get)

value : IOError: The error code.

The well-known error that has caused this I/O exception.

IOException

Description

Public / Constructors

Bad​Path

Cannot​Read

Cannot​Seek

Cannot​Write

Data​Format​Invalid

Data​Format​Not​Supported

File​Error

Missing​Privilege

Network​Error

Public / Methods

Missing​Privilege​Message

Throw​If​No​Create

Throw​If​No​Delete

Throw​If​No​Open

Throw​If​No​Read

Throw​If​No​Seek

Throw​If​No​Write

Public / Attributes

Error​Code

BadPath

CannotRead

CannotSeek

CannotWrite

DataFormatInvalid

DataFormatNotSupported

FileError

MissingPrivilege

NetworkError

MissingPrivilegeMessage

ThrowIfNoCreate

ThrowIfNoDelete

ThrowIfNoOpen

ThrowIfNoRead

ThrowIfNoSeek

ThrowIfNoWrite

ErrorCode