IFileOps

Description

interface Tinman.Core.IO.Files.IFileOps

Defines common operations of IFile objects.

The IFile object that is returned by the operation methods must be used by the caller instead of the IFile on which the method has been called.

[OwnerReturn] [OwnerThis]
public method Cache → (1)

Returns a IFile that accesses this file through the given in-memory file cache.

Calling IFlushable.Flush on the returned IFile will write all pending changes to disk.

[OwnerReturn] [OwnerThis]
public method Offset → (1)

offset ⁱⁿ : int64: [>=0]
Absolute offset in this file that will be mapped to offset 0 in the returned file.
returns → IFile: The resulting IFile object.

Returns a IFile that accesses the data in this file using the given byte offset.

[OwnerReturn]
public method ReadArchive → (1)

entry ^opt : string = null: Name of the archive entry to read or null to read the first entry.
returns → IDataStream: The data stream that reads the uncompressed archive entry.

Reads the file content as an archive.

[OwnerReturn] [OwnerThis]
public method ReadOnly → ()

Returns a read-only view on this IFile.