Zymba Documentation

IO.FileStream

Text

object @IO.FileStream(@IO.Stream) {
	MODE_CREATE;
	MODE_TRUNCATE;
	MODE_APPEND;
	MODE_OVERWRITE;
	construct(string $path, int $mode) {}
	attemptLock(): bool {}
	attemptLockShared(): bool {}
	canLock(): bool {}
	getSize(): int {}
	lock(): $this {}
	lockShared(): $this {}
	pad(int $size, string $padding): int {}
	selectLock(): object {}
	sync(): bool {}
	syncData(): bool {}
	unlock(): $this {}
}

IO file stream prototype.

Prototype

IO.Stream

Methods

Opens a stream to a file in a specific access mode (see MODE_* constants).

CODE

$this.construct(string $path, int $mode): void

Parameters

Name	Type	Value	Default
path	string		""
mode	int		MODE_READ

CODE

$this.attemptLock(): bool

Returns

Type	Value
bool

CODE

$this.attemptLockShared(): bool

Returns

Type	Value
bool

Determines whether this stream can be locked.

CODE

$this.canLock(): bool

Returns

Type	Value
bool

Gets the size of this stream in number of bytes.

CODE

$this.getSize(): int

Returns

Type	Value
int

CODE

$this.lock(): this

Returns

Type	Value
$this

CODE

$this.lockShared(): this

Returns

Type	Value
$this

Pads the content of this stream to a specific size in number of bytes by repeatedly appending it with a specific padding string and returns the number of bytes written.

CODE

$this.pad(int $size, string $padding): int

Parameters

Name	Type	Value	Default
size	int		0
padding	string		"\x00"

Returns

Type	Value
int

CODE

$this.selectLock(): @IO.LockContext

Returns

Type	Value
@IO.LockContext

Synchonizes this stream with the underlying storage device, including modified metadata.

CODE

$this.sync(): bool

Returns

Type	Value
bool

Synchonizes this stream with the underlying storage device, excluding modified metadata (if possible).

CODE

$this.syncData(): bool

Returns

Type	Value
bool

CODE

$this.unlock(): this

Returns

Type	Value
$this