home
wiki
classes/clusters list
class information
+
Point of view
All features
ANY
FILTER
INTERNALS_HANDLER
All features
deferred class FILTERABLE
Summary
top
The ability to be filtered (typically a stream of characters).
Direct parents
insert list:
ANY
Known children
inherit list:
TERMINAL_INPUT_OUTPUT_STREAM
insert list:
INPUT_STREAM
,
OUTPUT_STREAM
Overview
top
features
is_connected
:
BOOLEAN
True if the stream is connected.
disconnect
Try to disconnect the stream.
is_filtered
:
BOOLEAN
True if some filter is using this stream as backend.
detach
Shake off the filter.
can_disconnect
:
BOOLEAN
True if the stream can be safely disconnected (without data loss, etc.)
set_filter
(a_filter:
FILTER
)
Used by the filter itself to get attached
filter
:
FILTER
The filter that uses this stream as backend
filtered_descriptor
:
INTEGER_32
Find the descriptor of the terminal stream...
filtered_has_descriptor
:
BOOLEAN
True if the underlying terminal stream has a descriptor
filtered_stream_pointer
:
POINTER
Find the pointer of the terminal stream...
filtered_has_stream_pointer
:
BOOLEAN
True if the underlying terminal stream has a pointer
is_connected
:
BOOLEAN
deferred function
top
True if the stream is connected.
Only in that case can data be transfered via this stream.
disconnect
deferred procedure
top
Try to disconnect the stream.
Note that it *does not* ensure that the stream will effectively be disconnected (some terminal streams, for instance, are always connected) but the feature can be used to
"shake off"
filters.
require
is_connected
can_disconnect
ensure
not
is_filtered
is_filtered
:
BOOLEAN
effective function
top
True if some filter is using this stream as backend.
use that filter instead.
detach
deferred procedure
top
Shake off the filter.
ensure
not
is_filtered
can_disconnect
:
BOOLEAN
deferred function
top
True if the stream can be safely disconnected (without data loss, etc.)
require
is_connected
set_filter
(a_filter:
FILTER
)
effective procedure
top
Used by the filter itself to get attached
require
a_filter /= Void
ensure
filter
= a_filter
filter
:
FILTER
writable attribute
top
The filter that uses this stream as backend
filtered_descriptor
:
INTEGER_32
deferred function
top
Find the descriptor of the terminal stream...
Filters do not have descriptors of their own
require
is_connected
filtered_has_descriptor
filtered_has_descriptor
:
BOOLEAN
deferred function
top
True if the underlying terminal stream has a descriptor
require
is_connected
filtered_stream_pointer
:
POINTER
deferred function
top
Find the pointer of the terminal stream...
Filters do not have pointers of their own
require
is_connected
filtered_has_stream_pointer
filtered_has_stream_pointer
:
BOOLEAN
deferred function
top
True if the underlying terminal stream has a pointer
require
is_connected