class FileWriter

core :: FileWriter

Stream that can write to a File

Introduced properties

init from_fd(fd: Int)

core :: FileWriter :: from_fd

Creates a new File stream from a file descriptor
protected fun is_writable=(is_writable: Bool)

core :: FileWriter :: is_writable=

init open(path: String)

core :: FileWriter :: open

Open the file at path for writing.
private fun write_native(native: CString, from: Int, len: Int)

core :: FileWriter :: write_native

Write len bytes from native.

Redefined properties

redef type SELF: FileWriter

core $ FileWriter :: SELF

Type of this instance, automatically specialized in every class
redef fun close

core $ FileWriter :: close

close the stream
redef fun is_writable: Bool

core $ FileWriter :: is_writable

Can the stream be used to write
redef fun write(s: Text)

core $ FileWriter :: write

Write a string
redef fun write_byte(value: Int)

core $ FileWriter :: write_byte

Write a single byte
redef fun write_bytes_from_cstring(cs: CString, len: Int)

core $ FileWriter :: write_bytes_from_cstring

Write len bytes from ns

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _big_endian: Bool

binary :: BinaryStream :: _big_endian

Use the big-endian convention? otherwise use little-endian.
private var _codec: Codec

core :: Stream :: _codec

Codec used to transform raw data to text
private var _file: nullable NativeFile

core :: FileStream :: _file

The FILE *.
private var _last_error: nullable IOError

core :: Stream :: _last_error

Error produced by the file stream
private var _lookahead: CString

core :: Stream :: _lookahead

Lookahead buffer for codecs
private var _lookahead_capacity: Int

core :: Stream :: _lookahead_capacity

Capacity of the lookahead
private var _lookahead_length: Int

core :: Stream :: _lookahead_length

Current occupation of the lookahead
private var _path: nullable String

core :: FileStream :: _path

The path of the file.
private var _write_buffer: CString

core :: Stream :: _write_buffer

Buffer for writing data to a stream
fun big_endian: Bool

binary :: BinaryStream :: big_endian

Use the big-endian convention? otherwise use little-endian.
fun big_endian=(big_endian: Bool)

binary :: BinaryStream :: big_endian=

Use the big-endian convention? otherwise use little-endian.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun close

core :: Stream :: close

close the stream
fun codec: Codec

core :: Stream :: codec

Codec used to transform raw data to text
fun codec=(c: Codec)

core :: Stream :: codec=

Change the codec for this stream.
fun fd: Int

core :: FileStream :: fd

File descriptor of this file
private fun file: nullable NativeFile

core :: FileStream :: file

The FILE *.
private fun file=(file: nullable NativeFile)

core :: FileStream :: file=

The FILE *.
fun file_stat: nullable FileStat

core :: FileStream :: file_stat

The status of a file. see POSIX stat(2).
fun finish

core :: Stream :: finish

Post-work hook.
init from_fd(fd: Int)

core :: FileWriter :: from_fd

Creates a new File stream from a file descriptor
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun is_writable: Bool

core :: Writer :: is_writable

Can the stream be used to write
protected fun is_writable=(is_writable: Bool)

core :: FileWriter :: is_writable=

fun last_error: nullable IOError

core :: Stream :: last_error

Error produced by the file stream
protected fun last_error=(last_error: nullable IOError)

core :: Stream :: last_error=

Error produced by the file stream
protected fun lookahead: CString

core :: Stream :: lookahead

Lookahead buffer for codecs
protected fun lookahead=(lookahead: CString)

core :: Stream :: lookahead=

Lookahead buffer for codecs
protected fun lookahead_capacity: Int

core :: Stream :: lookahead_capacity

Capacity of the lookahead
protected fun lookahead_capacity=(lookahead_capacity: Int)

core :: Stream :: lookahead_capacity=

Capacity of the lookahead
protected fun lookahead_length: Int

core :: Stream :: lookahead_length

Current occupation of the lookahead
protected fun lookahead_length=(lookahead_length: Int)

core :: Stream :: lookahead_length=

Current occupation of the lookahead
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
init open(path: String)

core :: FileWriter :: open

Open the file at path for writing.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun path: nullable String

core :: FileStream :: path

The path of the file.
protected fun path=(path: nullable String)

core :: FileStream :: path=

The path of the file.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(value: nullable Serializable, plain: nullable Bool)

core :: Writer :: serialize_msgpack

Serialize value in MessagePack format
fun set_buffering_mode(buf_size: Int, mode: Int)

core :: FileStream :: set_buffering_mode

Sets the buffering mode for the current FileStream
protected fun set_codec(codec: Codec)

core :: Stream :: set_codec

Codec used to transform raw data to text
fun start

core :: Stream :: start

Pre-work hook.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun write(s: Text)

core :: Writer :: write

Write a string
fun write_bits(bits: Bool...)

core :: Writer :: write_bits

Write up to 8 Bool in a byte
fun write_block(text: Text)

core :: Writer :: write_block

Write the length as a 64 bits integer, then the content of text
fun write_bool(value: Bool)

core :: Writer :: write_bool

Write a boolean value on a byte, using 0 for false and 1 for true
protected fun write_buffer: CString

core :: Stream :: write_buffer

Buffer for writing data to a stream
protected fun write_buffer=(write_buffer: CString)

core :: Stream :: write_buffer=

Buffer for writing data to a stream
abstract fun write_byte(value: Int)

core :: Writer :: write_byte

Write a single byte
fun write_bytes(s: Bytes)

core :: Writer :: write_bytes

Write bytes from s
abstract fun write_bytes_from_cstring(ns: CString, len: Int)

core :: Writer :: write_bytes_from_cstring

Write len bytes from ns
fun write_char(c: Char)

core :: Writer :: write_char

Write a single char
fun write_double(value: Float)

core :: Writer :: write_double

Write a floating point value on 64 bits
fun write_float(value: Float)

core :: Writer :: write_float

Write a floating point value on 32 bits
fun write_int64(value: Int)

core :: Writer :: write_int64

Write value as a signed integer on 64 bits
fun write_msgpack_array(len: Int)

core :: Writer :: write_msgpack_array

Write an array header for len items in the shortest possible MessagePack array format
fun write_msgpack_array16(len: Int)

core :: Writer :: write_msgpack_array16

Write an array header for len items, max of 0xFFFF items
fun write_msgpack_array32(len: Int)

core :: Writer :: write_msgpack_array32

Write an array header for len items, max of 0xFFFF_FFFF items
fun write_msgpack_bin(data: Bytes)

core :: Writer :: write_msgpack_bin

Write data in the shortest possible MessagePack bin format
fun write_msgpack_bin16(data: Bytes)

core :: Writer :: write_msgpack_bin16

Write data in bin16 format, max of 0xFFFF bytes
fun write_msgpack_bin32(data: Bytes)

core :: Writer :: write_msgpack_bin32

Write data in bin32 format, max of 0xFFFF_FFFF bytes
fun write_msgpack_bin8(data: Bytes)

core :: Writer :: write_msgpack_bin8

Write data in bin8 format, max of 0xFF bytes
fun write_msgpack_bool(bool: Bool)

core :: Writer :: write_msgpack_bool

Write bool in MessagePack format
fun write_msgpack_double(value: Float)

core :: Writer :: write_msgpack_double

Write value as a MessagePack double
fun write_msgpack_ext(typ: Int, bytes: Bytes)

core :: Writer :: write_msgpack_ext

Write an application-specific extension for typ and bytes in the shortest possible MessagePack ext format
fun write_msgpack_ext16(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext16

Write the header for an application-specific extension of len data bytes
fun write_msgpack_ext32(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext32

Write the header for an application-specific extension of len data bytes
fun write_msgpack_ext8(typ: Int, len: Int)

core :: Writer :: write_msgpack_ext8

Write the header for an application-specific extension of len data bytes
fun write_msgpack_fixarray(len: Int)

core :: Writer :: write_msgpack_fixarray

Write an array header for len items, max of 0x0F items
fun write_msgpack_fixext1(typ: Int)

core :: Writer :: write_msgpack_fixext1

Write the header for an application-specific extension of one data byte
fun write_msgpack_fixext16(typ: Int)

core :: Writer :: write_msgpack_fixext16

Write the header for an application-specific extension of 16 data bytes
fun write_msgpack_fixext2(typ: Int)

core :: Writer :: write_msgpack_fixext2

Write the header for an application-specific extension of two data bytes
fun write_msgpack_fixext4(typ: Int)

core :: Writer :: write_msgpack_fixext4

Write the header for an application-specific extension of 4 data bytes
fun write_msgpack_fixext8(typ: Int)

core :: Writer :: write_msgpack_fixext8

Write the header for an application-specific extension of 8 data bytes
fun write_msgpack_fixint(value: Int)

core :: Writer :: write_msgpack_fixint

Write value as a single byte with metadata
fun write_msgpack_fixmap(len: Int)

core :: Writer :: write_msgpack_fixmap

Write a map header for len key/value pairs, max of 0x0F pairs
fun write_msgpack_fixstr(text: Text)

core :: Writer :: write_msgpack_fixstr

Write text in fixstr format, max of 0x1F bytes
fun write_msgpack_float(value: Float)

core :: Writer :: write_msgpack_float

Write value as a MessagePack float (losing precision)
fun write_msgpack_int(value: Int)

core :: Writer :: write_msgpack_int

Write the integer value either as the shortest possible MessagePack int
fun write_msgpack_int16(value: Int)

core :: Writer :: write_msgpack_int16

Write value over two signed bytes, following 1 metadata byte
fun write_msgpack_int32(value: Int)

core :: Writer :: write_msgpack_int32

Write value over 4 signed bytes, following 1 metadata byte
fun write_msgpack_int64(value: Int)

core :: Writer :: write_msgpack_int64

Write value over 8 signed bytes, following 1 metadata byte
fun write_msgpack_int8(value: Int)

core :: Writer :: write_msgpack_int8

Write value over one signed byte, following 1 metadata byte
fun write_msgpack_map(len: Int)

core :: Writer :: write_msgpack_map

Write a map header for len keys/value pairs in the shortest possible MessagePack map format
fun write_msgpack_map16(len: Int)

core :: Writer :: write_msgpack_map16

Write a map header for len key/value pairs, max of 0xFFFF pairs
fun write_msgpack_map32(len: Int)

core :: Writer :: write_msgpack_map32

Write a map header for len key/value pairs, max of 0xFFFF_FFFF pairs
fun write_msgpack_null

core :: Writer :: write_msgpack_null

Write null, or nil, in MessagePack format
fun write_msgpack_str(text: Text)

core :: Writer :: write_msgpack_str

Write text in the shortest possible MessagePack format
fun write_msgpack_str16(text: Text)

core :: Writer :: write_msgpack_str16

Write text in str16 format, max of 0xFFFF bytes
fun write_msgpack_str32(text: Text)

core :: Writer :: write_msgpack_str32

Write text in str32 format, max of 0xFFFF_FFFF bytes
fun write_msgpack_str8(text: Text)

core :: Writer :: write_msgpack_str8

Write text in str8 format, max of 0xFF bytes
fun write_msgpack_uint16(value: Int)

core :: Writer :: write_msgpack_uint16

Write value over two unsigned bytes, following 1 metadata byte
fun write_msgpack_uint32(value: Int)

core :: Writer :: write_msgpack_uint32

Write value over 4 unsigned bytes, following 1 metadata byte
fun write_msgpack_uint64(value: Int)

core :: Writer :: write_msgpack_uint64

Write value over 8 unsigned bytes, following 1 metadata byte
fun write_msgpack_uint8(value: Int)

core :: Writer :: write_msgpack_uint8

Write value over one unsigned byte, following 1 metadata byte
private fun write_native(native: CString, from: Int, len: Int)

core :: FileWriter :: write_native

Write len bytes from native.
fun write_string(text: Text)

core :: Writer :: write_string

Write text as a null terminated string
package_diagram core::FileWriter FileWriter core::FileStream FileStream core::FileWriter->core::FileStream core::Writer Writer core::FileWriter->core::Writer core::Stream Stream core::FileStream->core::Stream binary::BinaryStream BinaryStream core::Writer->binary::BinaryStream ...core::Stream ... ...core::Stream->core::Stream ...binary::BinaryStream ... ...binary::BinaryStream->binary::BinaryStream core::Stdout Stdout core::Stdout->core::FileWriter core::Stderr Stderr core::Stderr->core::FileWriter

Ancestors

abstract class BinaryStream

binary :: BinaryStream

A stream of binary data
interface Object

core :: Object

The root of the class hierarchy.
abstract class Stream

core :: Stream

Any kind of stream to read/write/both to or from a source

Parents

abstract class FileStream

core :: FileStream

Stream used to interact with a File or FileDescriptor
abstract class Writer

core :: Writer

A Stream that can be written to

Children

class Stderr

core :: Stderr

Standard error stream.
class Stdout

core :: Stdout

Standard output stream.

Class definitions

core $ FileWriter 
# `Stream` that can write to a File
class FileWriter
	super FileStream
	super Writer

	redef fun write_bytes_from_cstring(cs, len) do
		if last_error != null then return
		if not _is_writable then
			last_error = new IOError("cannot write to non-writable stream")
			return
		end
		write_native(cs, 0, len)
	end

	redef fun write(s)
	do
		if last_error != null then return
		if not _is_writable then
			last_error = new IOError("cannot write to non-writable stream")
			return
		end
		s.write_native_to(self)
	end

	redef fun write_byte(value)
	do
		if last_error != null then return
		if not _is_writable then
			last_error = new IOError("Cannot write to non-writable stream")
			return
		end
		if _file.as(not null).address_is_null then
			last_error = new IOError("Writing on a null stream")
			_is_writable = false
			return
		end

		var err = _file.as(not null).write_byte(value)
		if err != 1 then
			# Big problem
			last_error = new IOError("Problem writing a byte: {err}")
		end
	end

	redef fun close
	do
		super
		_is_writable = false
	end
	redef var is_writable = false

	# Write `len` bytes from `native`.
	private fun write_native(native: CString, from, len: Int)
	do
		if last_error != null then return
		if not _is_writable then
			last_error = new IOError("Cannot write to non-writable stream")
			return
		end
		if _file.as(not null).address_is_null then
			last_error = new IOError("Writing on a null stream")
			_is_writable = false
			return
		end
		var err = _file.as(not null).io_write(native, from, len)
		if err != len then
			# Big problem
			last_error = new IOError("Problem in writing : {err} {len} \n")
		end
	end

	# Open the file at `path` for writing.
	init open(path: String)
	do
		_file = new NativeFile.io_open_write(path.to_cstring)
		self.path = path
		_is_writable = true
		if _file.as(not null).address_is_null then
			last_error = new IOError("Cannot open `{path}`: {sys.errno.strerror}")
			is_writable = false
		end
	end

	# Creates a new File stream from a file descriptor
	init from_fd(fd: Int) do
		self.path = ""
		_file = fd.fd_to_stream(wipe_write)
		_is_writable = true
		 if _file.as(not null).address_is_null then
			 last_error = new IOError("Error: Opening stream from file descriptor {fd} failed with '{sys.errno.strerror}'")
			_is_writable = false
		end
	end
end
lib/core/file.nit:207,1--300,3
Nit tools. Version .