indexing
description: "Encapsulation of standard implementation of IStream interface."
legal: "See notice at end of class."
status: "See notice at end of class."
date: "$Date: 2006-04-25 12:20:38 -0700 (Tue, 25 Apr 2006) $"
revision: "$Revision: 58454 $"
class interface
ECOM_STREAM
create
make_from_other (other: ECOM_INTERFACE)
ECOM_QUERIABLE
require ECOM_QUERIABLE
non_void_other: other /= Void
ensure ECOM_QUERIABLE
valid_initializer: initializer /= default_pointer
exists: exists
make_from_pointer (cpp_obj: POINTER)
require ECOM_QUERIABLE
non_default_pointer: cpp_obj /= default_pointer
ensure ECOM_QUERIABLE
valid_initializer: initializer /= default_pointer
exists: exists
feature
hresult: INTEGER_32
ECOM_EXCEPTION
require ECOM_EXCEPTION
applicable: is_developer_exception
hresult_code: INTEGER_32
ECOM_EXCEPTION
require ECOM_EXCEPTION
applicable: is_developer_exception
hresult_facility: INTEGER_32
ECOM_EXCEPTION
require ECOM_EXCEPTION
applicable: is_developer_exception
hresult_message: STRING_8
ECOM_EXCEPTION
require ECOM_EXCEPTION
applicable: is_developer_exception
ensure ECOM_EXCEPTION
non_void_message: Result /= Void
feature
access_time: WEL_FILE_TIME
check_instruction: INTEGER_32 is 7
EXCEP_CONST
class_invariant: INTEGER_32 is 6
EXCEP_CONST
com_exception: INTEGER_32 is 28
EXCEP_CONST
create_on_deferred: INTEGER_32 is 17
EXCEP_CONST
creation_time: WEL_FILE_TIME
description (stat_flag: INTEGER_32): ECOM_STATSTG
`stat_flag'
require
valid_stat_flag: is_valid_stat_flag (stat_flag)
ensure
Result /= Void
developer_exception: INTEGER_32 is 24
EXCEP_CONST
dollar_applied_to_melted_feature: INTEGER_32 is 26
EXCEP_CONST
eiffel_runtime_fatal_error: INTEGER_32 is 25
EXCEP_CONST
eiffel_runtime_panic: INTEGER_32 is 13
EXCEP_CONST
end_of_stream: BOOLEAN
readupdate_end_of_streamstartfinish
exception_in_signal_handler: INTEGER_32 is 20
EXCEP_CONST
exists: BOOLEAN
ECOM_QUERIABLE
external_exception: INTEGER_32 is 18
`errno'
EXCEP_CONST
floating_point_exception: INTEGER_32 is 5
EXCEP_CONST
generating_type: STRING_8
ANY
generator: STRING_8
ANY
incorrect_inspect_value: INTEGER_32 is 9
EXCEP_CONST
io_exception: INTEGER_32 is 21
EXCEP_CONST
is_valid_lock (lock: INTEGER_32): BOOLEAN
`lock'
ECOM_LOCK_TYPES
is_valid_seek (seek: INTEGER_32): BOOLEAN
seek
ECOM_STREAM_SEEK
is_valid_stat_flag (flag: INTEGER_32): BOOLEAN
`flag'
ECOM_STAT_FLAGS
item: POINTER
ECOM_QUERIABLE
last_boolean: BOOLEAN
last_character: CHARACTER_8
last_integer: INTEGER_32
last_real: REAL_32
last_string: STRING_8
lock_exclusive: INTEGER_32
ECOM_LOCK_TYPES
lock_onlyonce: INTEGER_32
ECOM_LOCK_TYPES
lock_write: INTEGER_32
ECOM_LOCK_TYPES
locks_supported: INTEGER_32
loop_invariant: INTEGER_32 is 11
EXCEP_CONST
loop_variant: INTEGER_32 is 10
EXCEP_CONST
modification_time: WEL_FILE_TIME
name: STRING_8
no_more_memory: INTEGER_32 is 2
EXCEP_CONST
number_of_codes: INTEGER_32 is 29
EXCEP_CONST
operating_system_exception: INTEGER_32 is 22
`errno'
EXCEP_CONST
out_of_memory: INTEGER_32 is 15
EXCEP_CONST
postcondition: INTEGER_32 is 4
EXCEP_CONST
precondition: INTEGER_32 is 3
EXCEP_CONST
rescue_exception: INTEGER_32 is 14
EXCEP_CONST
resumption_failed: INTEGER_32 is 16
EXCEP_CONST
retrieve_exception: INTEGER_32 is 23
`retrieved'`IO_MEDIUM'
EXCEP_CONST
routine_failure: INTEGER_32 is 8
EXCEP_CONST
runtime_check_exception: INTEGER_32 is 29
EXCEP_CONST
runtime_io_exception: INTEGER_32 is 27
EXCEP_CONST
signal_exception: INTEGER_32 is 12
EXCEP_CONST
size: ECOM_ULARGE_INTEGER
statflag_default: INTEGER_32
ECOM_STAT_FLAGS
statflag_noname: INTEGER_32
ECOM_STAT_FLAGS
stream_seek_cur: INTEGER_32
ECOM_STREAM_SEEK
stream_seek_end: INTEGER_32
ECOM_STREAM_SEEK
stream_seek_set: INTEGER_32
ECOM_STREAM_SEEK
valid_code (c: INTEGER_32): BOOLEAN
`c'
EXCEP_CONST
void_assigned_to_expanded: INTEGER_32 is 19
EXCEP_CONST
void_call_target: INTEGER_32 is 1
EXCEP_CONST
feature
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
frozen equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
frozen standard_is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature
assertion_violation: BOOLEAN
EXCEPTIONS
class_name: STRING_8
EXCEPTIONS
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
developer_exception_name: STRING_8
EXCEPTIONS
require EXCEPTIONS
applicable: is_developer_exception
exception: INTEGER_32
EXCEPTIONS
exception_trace: STRING_8
EXCEPTIONS
is_developer_exception: BOOLEAN
EXCEPTIONS
is_developer_exception_of_name (name: STRING_8): BOOLEAN
name
EXCEPTIONS
is_signal: BOOLEAN
EXCEPTIONS
is_system_exception: BOOLEAN
EXCEPTIONS
meaning (except: INTEGER_32): STRING_8
`except'
EXCEPTIONS
original_class_name: STRING_8
EXCEPTIONS
original_exception: INTEGER_32
EXCEPTIONS
original_recipient_name: STRING_8
EXCEPTIONS
original_tag_name: STRING_8
EXCEPTIONS
recipient_name: STRING_8
EXCEPTIONS
same_type (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
tag_name: STRING_8
EXCEPTIONS
feature
catch (code: INTEGER_32)
`code'
EXCEPTIONS
die (code: INTEGER_32)
`code'
EXCEPTIONS
ignore (code: INTEGER_32)
`code'
EXCEPTIONS
message_on_failure
EXCEPTIONS
no_message_on_failure
EXCEPTIONS
raise (name: STRING_8)
name
EXCEPTIONS
raise_retrieval_exception (name: STRING_8)
name
EXCEPTIONS
feature
copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
copy`other'deep_twin
ANY
require ANY
other_not_void: other /= Void
ensure ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
ANY
ensure ANY
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
`other'
ANY
ensure ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
`Current'
twincopycopy
ANY
ensure ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
feature
clone_stream: ECOM_STREAM
ensure
clone_created: Result /= Void and then Result.exists
copy_to (destination: ECOM_STREAM; bytes: ECOM_ULARGE_INTEGER)
`bytes'
`destination'
require
valid_destination: destination /= Void and then destination.exists
valid_bytes_number: bytes /= Void and then bytes.exists
finish
ensure
at_end: end_of_stream
lock_region (offset, count: ECOM_ULARGE_INTEGER; lock: INTEGER_32)
`offset'`count'
require
valid_offset: offset /= Void and then offset.exists
valid_count: count /= Void and then count.exists
valid_lock: is_valid_lock (lock)
read (buffer: POINTER; bytes: INTEGER_32)
`bytes'
`buffer'
require
valid_buffer: buffer /= default_pointer
valid_bytes: bytes >= 0
read_boolean
read_character
read_integer
read_real
read_string
seek (displacement: ECOM_LARGE_INTEGER; origin: INTEGER_32)
`displacement'
`origin'
`origin'
require
non_void_displacement: displacement /= Void
valid_displacement: displacement.exists
valid_seek_origin: is_valid_seek (origin)
set_size (new_size: ECOM_ULARGE_INTEGER)
`new_size'
require
valid_new_size: new_size /= Void and then new_size.exists
ensure
size = new_size
start
ensure
not_end: not end_of_stream
unlock_region (offset, count: ECOM_ULARGE_INTEGER; lock: INTEGER_32)
`offset'`count'
require
valid_offset: offset /= Void and then offset.exists
valid_count: count /= Void and then count.exists
valid_lock: is_valid_lock (lock)
update_end_of_stream
end_of_stream
write (buffer: POINTER; bytes: INTEGER_32)
`bytes'
require
valid_buffer: buffer /= default_pointer
write_boolean (boolean: BOOLEAN)
`boolean'
write_character (character: CHARACTER_8)
`character'
write_integer (integer: INTEGER_32)
`integer'
write_real (real: REAL_32)
`real'
write_string (string: STRING_8)
`string'
require
string /= Void
feature
trigger (code: INTEGER_32)
`code'
ECOM_EXCEPTION
feature
io: STD_FILES
ANY
out: STRING_8
ANYtagged_out
ANY
print (some: ANY)
`some'
ANY
frozen tagged_out: STRING_8
ANYout
ANY
feature
operating_environment: OPERATING_ENVIRONMENT
ANY
invariant
ECOM_QUERIABLE
queriable_invariant: initializer /= default_pointer and then exists
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
indexing
copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[
Eiffel Software
356 Storke Road, Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Website http://www.eiffel.com
Customer support http://support.eiffel.com
]"
end ECOM_STREAM