Generic File IO

Overview

This section describes types and facilities for working with files and generic IO devices. More…

import "io_base.jncx"
import "io_File.jnc"
import "io_FileStream.jnc"
import "io_MappedFile.jnc"
import "io_Mailslot.jnc"
import "io_NamedPipe.jnc"

// typedefs

typedef io.StreamOptions io.ChildProcessOptions;
typedef io.ReadOnlyStreamOptions io.MailslotOptions;
typedef io.ReadOnlyStreamEvents io.MailslotEvents;

// enums

bitflag enum io.ChildProcessEvents;
bitflag enum io.ChildProcessStartFlags;
enum io.FileKind;
bitflag enum io.FileOpenFlags;
bitflag enum io.FileStreamEvents;
bitflag enum io.FileStreamOptions;
bitflag enum io.NamedPipeEvents;
bitflag enum io.ReadOnlyStreamEvents;
bitflag enum io.ReadOnlyStreamOptions;
bitflag enum io.StreamEvents;
bitflag enum io.StreamOptions;

// structs

struct io.PtySize;

// classes

class io.ChildProcess;
class io.File;
class io.FileStream;
class io.Mailslot;
class io.MappedFile;
class io.NamedPipe;

// global functions

string_t io.getFileStreamKindString(io.FileKind kind);
string_t io.getSymbolicLinkTarget(string_t name);
string_t io.getHomeDir();
string_t io.getTempDir();

string_t io.createTempFile(
    string_t dir = null,
    string_t prefix = null
);

bool errorcode io.renameFile(
    string_t srcFileName,
    string_t dstFileName
);

bool errorcode io.deleteFile(string_t fileName);

Detailed Documentation

This section describes types and facilities for working with files and generic IO devices.

Global Functions

string_t io.getFileStreamKindString(io.FileKind kind)

Returns string representation of the kind argument. In case kind does not correspond to any known file stream kind(e.g. you have casted a random integer number to io.FileKind enumeration type), string unknown device is returned.