+
Point of view
All features
class BINARY_FILE_WRITE
Summary
top
This class allow to write a file on the disk as a binary file (ie. file containing bytes). If you need to write text in a file, then consider using TEXT_FILE_WRITE.
Direct parents
Inherit list: BINARY_OUTPUT_STREAM, DISPOSABLE, FILE_STREAM, TERMINAL_OUTPUT_STREAM
Class invariant
top
Overview
top
Creation features
{ANY}
Features
{ANY}
{FILTER_OUTPUT_STREAM}
{FILTER}
{}
built-ins
{}
{ANY}
{FILTER}
{ANY}
{}
{ANY}
{}
{STREAM_HANDLER}
{ANY}
{}
{RECYCLING_POOL}
  • recycle
    Do whatever needs to be done to free resources or recycle other objects when recycling this one
{}
{ANY}
{ABSTRACT_STRING}
{ANY}
To write a number:
{ANY}
Other features:
{ANY}
{}
{}
{FILTER}
{ANY}
  • path: STRING
    Not Void when connected to the corresponding file on the disk.
{}
connect_to (new_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Truncate file to zero length or create binary file for writing.
connect_for_appending_to (new_path: STRING)
effective procedure
{ANY}
top
Truncate file to zero length or create binary file for writing.
disconnect
effective procedure
{ANY}
top
Try to disconnect the stream.
put_byte (byte: INTEGER_32)
effective procedure
{ANY}
top
put_integer_16_native_endian (i: INTEGER_16)
effective procedure
{ANY}
top
Write in the same order as the machine running this code.
put_integer_16_big_endian (i: INTEGER_16)
effective procedure
{ANY}
top
Write i in big endian mode.
put_integer_16_little_endian (i: INTEGER_16)
effective procedure
{ANY}
top
Write i in little endian mode.
put_integer_32_native_endian (i: INTEGER_32)
effective procedure
{ANY}
top
Write in the same order as the machine running this code.
put_integer_32_big_endian (i: INTEGER_32)
effective procedure
{ANY}
top
Write i in big endian mode.
put_integer_32_little_endian (i: INTEGER_32)
effective procedure
{ANY}
top
Write i in little endian mode.
terminal_settings: TERMINAL_SETTINGS
effective function
{ANY}
top
filtered_put_character (c: CHARACTER)
effective procedure
{FILTER_OUTPUT_STREAM}
top
filtered_flush
effective procedure
{FILTER_OUTPUT_STREAM}
top
forces a write of unwritten character (write my have been delayed, flush writes buffered characters)
filtered_descriptor: INTEGER_32
is 0
constant attribute
{FILTER}
top
Find the descriptor of the terminal stream...
filtered_has_descriptor: BOOLEAN
is False
constant attribute
{FILTER}
top
True if the underlying terminal stream has a descriptor
filtered_stream_pointer: POINTER
effective function
{FILTER}
top
Find the pointer of the terminal stream...
filtered_has_stream_pointer: BOOLEAN
is True
constant attribute
{FILTER}
top
True if the underlying terminal stream has a pointer
writable attribute
{}
top
buffer_position: INTEGER_32
writable attribute
{}
top
capacity: INTEGER_32
writable attribute
{}
top
output_stream: POINTER
writable attribute
{}
top
the_terminal_settings: TERMINAL_SETTINGS
writable attribute
{}
top
make
effective procedure
{}
top
The new created object is not connected.
dispose
effective procedure
{}
top
Action to be executed just before garbage collection reclaims an object.
write_buffer
effective procedure
{}
top
put_16_ne (a_buf: NATIVE_ARRAY[CHARACTER], i: INTEGER_16, ch_pos: INTEGER_32)
{}
top
put_16_le (a_buf: NATIVE_ARRAY[CHARACTER], i: INTEGER_16, ch_pos: INTEGER_32)
{}
top
put_16_be (a_buf: NATIVE_ARRAY[CHARACTER], i: INTEGER_16, ch_pos: INTEGER_32)
{}
top
put_32_ne (a_buf: NATIVE_ARRAY[CHARACTER], i: INTEGER_32, ch_pos: INTEGER_32)
{}
top
put_32_le (a_buf: NATIVE_ARRAY[CHARACTER], i: INTEGER_32, ch_pos: INTEGER_32)
{}
top
put_32_be (a_buf: NATIVE_ARRAY[CHARACTER], an_i: INTEGER_32, ch_pos: INTEGER_32)
{}
top
binary_file_write_open (a_path_pointer: POINTER): POINTER
{}
top
binary_file_write_append (a_path_pointer: POINTER): POINTER
{}
top
fclose (a_stream_pointer: POINTER)
{}
top
put_character (c: CHARACTER)
effective procedure
{ANY}
top
flush
effective procedure
{ANY}
top
Flushes the pipe.
can_put_character (c: CHARACTER): BOOLEAN
deferred function
{ANY}
top
detach
effective procedure
{ANY}
top
Shake off the filter.
writable attribute
{FILTER}
top
The filter that uses this stream as backend
event_can_write: EVENT_DESCRIPTOR
effective function
{ANY}
top
writable attribute
{}
top
new_url: URL
effective function
{}
top
as_output_stream: OUTPUT_STREAM
effective function
{}
top
is_connected: BOOLEAN
deferred function
{ANY}
top
True if the stream is connected.
descriptor: INTEGER_32
effective function
{ANY}
top
Some OS-dependent descriptor.
has_descriptor: BOOLEAN
effective function
{ANY}
top
True if that stream can be associated to some OS-meaningful descriptor.
can_disconnect: BOOLEAN
deferred function
{ANY}
top
True if the stream can be safely disconnected (without data loss, etc.)
url: URL
frozen
effective function
{ANY}
top
The URL to this stream as resource
url_memory: URL
writable attribute
{}
top
stream_pointer: POINTER
effective function
{STREAM_HANDLER}
top
Some Back-end-dependent pointer (FILE* in C, InputStream or OutputStream in Java)
has_stream_pointer: BOOLEAN
effective function
{STREAM_HANDLER}
top
True if that stream can be associated to some Back-end-meaningful stream pointer.
event_exception: EVENT_DESCRIPTOR
effective function
{ANY}
top
stream_exception: STREAM_EXCEPTION
writable attribute
{}
top
recycle
effective procedure
{RECYCLING_POOL}
top
Do whatever needs to be done to free resources or recycle other objects when recycling this one
sequencer_descriptor (file: POINTER): INTEGER_32
{}
top
is_filtered: BOOLEAN
deferred function
{ANY}
top
put_natively_stored_string (s: NATIVELY_STORED_STRING)
effective procedure
{ABSTRACT_STRING}
top
put_abstract_string (s: ABSTRACT_STRING)
effective procedure
{ABSTRACT_STRING}
top
put_string (s: ABSTRACT_STRING)
effective procedure
{ANY}
top
Output s to current output device.
put_unicode_string (unicode_string: UNICODE_STRING)
effective procedure
{ANY}
top
Output the UTF-8 encoding of the unicode_string.
put_line (s: ABSTRACT_STRING)
effective procedure
{ANY}
top
Output the string followed by a '%N'.
put_integer (i: INTEGER_64)
frozen
effective procedure
{ANY}
top
Output i to current output device.
put_integer_format (i: INTEGER_64, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output i to current output device using at most s character.
put_natural_8 (n: NATURAL_8)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_8_format (n: NATURAL_8, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_16 (n: NATURAL_16)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_16_format (n: NATURAL_16, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_32 (n: NATURAL_32)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_32_format (n: NATURAL_32, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_natural_64 (n: NATURAL_64)
frozen
effective procedure
{ANY}
top
Output n to current output device.
put_natural_64_format (n: NATURAL_64, s: INTEGER_32)
frozen
effective procedure
{ANY}
top
Output n to current output device using at most s character.
put_real (r: REAL_64)
effective procedure
{ANY}
top
Output r to current output device.
put_real_format (r: REAL_64, f: INTEGER_32)
effective procedure
{ANY}
top
Output r with only f digit for the fractional part.
put_real_scientific (r: REAL_64, f: INTEGER_32)
effective procedure
{ANY}
top
Output r using the scientific notation with only f digit for the fractional part.
put_number (number: NUMBER)
effective procedure
{ANY}
top
Output the number.
put_boolean (b: BOOLEAN)
effective procedure
{ANY}
top
Output b to current output device according to the Eiffel format.
put_pointer (p: POINTER)
effective procedure
{ANY}
top
Output a viewable version of p.
put_new_line
effective procedure
{ANY}
top
Output a newline character.
put_spaces (nb: INTEGER_32)
effective procedure
{ANY}
top
Output nb spaces character.
append_file (file_name: STRING)
effective procedure
{ANY}
top
tmp_file_read: TEXT_FILE_READ
once function
{}
top
tmp_string: STRING
once function
{}
top
io_putc (byte: CHARACTER, stream: POINTER)
{}
top
io_fwrite (buf: NATIVE_ARRAY[CHARACTER], size: INTEGER_32, stream: POINTER): INTEGER_32
{}
top
io_flush (stream: POINTER)
{}
top
set_filter (a_filter: FILTER)
effective procedure
{FILTER}
top
Used by the filter itself to get attached
path: STRING
writable attribute
{ANY}
top
Not Void when connected to the corresponding file on the disk.
set_path (new_path: ABSTRACT_STRING)
effective procedure
{}
top