TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class IOException in Tinman.Core.IO

An unexpected I/O error has occurred.

sealed class IOException extends TinmanException

Public / Attributes

ErrorCode

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

public property ErrorCode { get }
type IOError
value The error code.

ErrorInfo

The TinmanError object that describes the error that has occurred.

public property ErrorInfo { get }
type TinmanError
value [not-null] The TinmanError object.
inherited TinmanException.ErrorInfo

Message

[Pure]
public override sealed property Message { get }
type string
value
inherited TinmanException.Message

Source

The error source (see ErrorSource).

public property Source { get }
type string
value The error source tag.
inherited TinmanException.Source

Public / Constructors

BadPath

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

public static method BadPath (string source, string invalidPath)
type IOException
params source The error source (see ErrorSource).
  invalidPath The invalid path string.
returns The ready-to-throw exception.

CannotRead

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

public static method CannotRead (string source, Path path)
type IOException
params source The error source (see ErrorSource).
  path Optional path info value.
returns The ready-to-throw exception.

CannotSeek

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

public static method CannotSeek (string source, Path path)
type IOException
params source The error source (see ErrorSource).
  path Optional path info value.
returns The ready-to-throw exception.

CannotWrite

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

public static method CannotWrite (string source, Path path)
type IOException
params source The error source (see ErrorSource).
  path Optional path info value.
returns The ready-to-throw exception.

DataFormatInvalid

Some binary data format is invalid.

public static method DataFormatInvalid (string source, string fileFormat, string message = null)
type IOException
params source The error source (see ErrorSource).
  fileFormat Name of the binary file format.
  message Optional error message.
returns The ready-to-throw exception.

The binary format of the given file is invalid.

public static method DataFormatInvalid (string source, Path filePath, string fileFormat, string message = null)
type IOException
params source The error source (see ErrorSource).
  filePath Path to the file.
  fileFormat Name of the binary file format.
  message Optional error message.
returns The ready-to-throw exception.

DataFormatNotSupported

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

public static method DataFormatNotSupported (string source, Path filePath, string format, string what)
type IOException
params source The error source (see ErrorSource).
  filePath Path to the file.
  format Name of the binary data format.
  what Describes the feature or version that is not supported.
returns The ready-to-throw exception.

FileError

A general filesystem IO error has occurred.

public static method FileError (string source, string message)
type IOException
params source The error source (see ErrorSource).
  message The error message.
returns The ready-to-throw exception.

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

public static method FileError (string source, Path path)
type IOException
params source The error source (see ErrorSource).
  path The file path.
returns The ready-to-throw exception.

Remarks:

Error details are fetched from last OS error code.


A general filesystem IO error has occurred.

public static method FileError (string source, int32 error, string message)
type IOException
params source The error source (see ErrorSource).
  error The file error code.
  message The error message.
returns The ready-to-throw exception.

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

public static method FileError (string source, Path path, int32 error)
type IOException
params source The error source (see ErrorSource).
  path The file path.
  error The file error code.
returns The ready-to-throw exception.

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

public static method FileError (string source, Path path, IOError error)
type IOException
params source The error source (see ErrorSource).
  path The file path.
  error The well-known error code.
returns The ready-to-throw exception.

An unexpected IO error has occurred while accessing a file.

public static method FileError (string source, Path filePath, string message)
type IOException
params source The error source (see ErrorSource).
  filePath Path to the file being accessed.
  message The error message.
returns The ready-to-throw exception.

NetworkError

An unexpected IO error has occurred while accessing the network.

public static method NetworkError (string source, string message)
type IOException
params source The error source (see ErrorSource).
  message The error message.
returns The ready-to-throw exception.

An unexpected IO error has occurred while accessing the network.

public static method NetworkError (string source, int32 error, string message = null)
type IOException
params source The error source (see ErrorSource).
  error The network error code.
  message Optional error message.
returns The ready-to-throw exception.

Public / Methods

ThrowIfNoCreate

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

public static method ThrowIfNoCreate (ICanCreateOpenDelete obj)
params obj [not-null] The I/O object.

Exceptions:

ThrowIfNoDelete

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

public static method ThrowIfNoDelete (ICanCreateOpenDelete obj)
params obj [not-null] The I/O object.

Exceptions:

ThrowIfNoOpen

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

public static method ThrowIfNoOpen (ICanCreateOpenDelete obj)
params obj [not-null] The I/O object.

Exceptions:

ThrowIfNoRead

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

public static method ThrowIfNoRead (ICanReadWrite obj)
params obj [not-null] The I/O object.

Exceptions:

ThrowIfNoSeek

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

public static method ThrowIfNoSeek (IDataStream stream)
params stream [not-null] The I/O stream.

Exceptions:

ThrowIfNoWrite

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

public static method ThrowIfNoWrite (ICanReadWrite obj)
params obj [not-null] The I/O object.

Exceptions:


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

public static method ThrowIfNoWrite (IDataStream obj)
params obj [not-null] The I/O object.

Exceptions:

ToString

[Pure]
public override sealed method ToString ()
type string
inherited TinmanException.ToString