GitHub
LibrariesOpen source libraries used to build this documentation site.
LibraryRoleVersionLicense
AstroastroSite framework6.3.1MIT
Astro React@astrojs/reactReact integration5.0.4MIT
Astro Sitemap@astrojs/sitemapSitemap generation3.7.2MIT
UI5 Web Components@ui5/webcomponentsUI primitives2.22.0Apache-2.0
UI5 Web Components Fiori@ui5/webcomponents-fioriFiori shell components2.22.0Apache-2.0
UI5 Web Components Icons@ui5/webcomponents-iconsIcon set2.22.0Apache-2.0
UI5 Web Components React@ui5/webcomponents-reactReact wrappers2.22.0Apache-2.0
ReactreactUI runtime19.2.6MIT
React DOMreact-domDOM renderer19.2.6MIT
ShikishikiSyntax highlighting4.0.2MIT
Docs/ORK/IO_STREAMS/ORK/IF_IO_STREAM_BASE
Interface/ORK/IF_IO_STREAM_BASE
Stream (BaseClass)
InterfaceStream (BaseClass)
Package
/ORK/IO_STREAMS
Members
17
15 items
Methods
can_expand
Method

Gets a value indicating whether the current stream supports dynamic expansion of its length.

  • If true, writing beyond the current end of the stream will grow its length automatically.
  • If false, attempts to write past the end will result in an error or be ignored.

Parameters

NameDescriptionresulttrue if the stream grows on writes past its end. false if the stream length is fixed.

Signature

METHODS can_expand RETURNING VALUE(result) TYPE abap_bool.
can_read
Method

Gets a value indicating whether the current stream supports reading.

  • If a Stream does not support reading, calls to the Read method throw a NotSupportedException.

Parameters

NameDescriptionresulttrue if the stream supports reading; otherwise, false

Signature

METHODS can_read RETURNING VALUE(result) TYPE abap_bool.
can_seek
Method

Gets a value indicating whether the current stream supports seeking.

  • If a Stream does not support seeking, calls to /ork/if_io_stream_base.METH:get_length, /ork/if_io_stream_base.METH:set_length, /ork/if_io_stream_base.METH:get_position, /ork/if_io_stream_base.METH:set_position and /ork/if_io_stream_base.METH:seek may throw a NotSupportedException.

Parameters

NameDescriptionresulttrue if the stream supports seeking; otherwise, false.

Signature

METHODS can_seek RETURNING VALUE(result) TYPE abap_bool.
can_write
Method

Gets a value indicating whether the current stream supports writing.

  • If a class derived from Stream does not support writing, a call to write throws a NotSupportedException.

Parameters

NameDescriptionresulttrue if the stream supports writing; otherwise, false.

Signature

METHODS can_write RETURNING VALUE(result) TYPE abap_bool.
close
Method

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.

Signature

METHODS close.
get_length
Method

Gets the length in bytes of the stream.

  • Can throw a NotSupportedException if the stream does not support seeking and the length is unknown.

Parameters

NameDescriptionresultA long value representing the length of the stream in bytes.

Signature

METHODS get_length RETURNING VALUE(result) TYPE int8.
get_position
Method

Gets the position within the current stream.

  • The stream must support seeking to get position. Use the /ork/if_io_stream_base.METH:can_seek method to determine whether the stream supports seeking.

Parameters

NameDescriptionresultThe current position within the stream.

Signature

METHODS get_position RETURNING VALUE(result) TYPE int8.
set_position
Method

Sets the position within the current stream.

  • The stream must support seeking to set the position. Use the /ork/if_io_stream_base.METH:can_seek method to determine whether the stream supports seeking.

Parameters

NameDescriptionpositionPosition within the stream that is to be set.

Signature

METHODS set_position IMPORTING !position TYPE int8.
seek
Method

Sets the position within the current stream.

Parameters

NameDescriptionoffsetA byte offset relative to the /ork/if_io_stream_base.METH:seek.DATA:origin parameter.originA value of /ork/if_io_stream_base.DATA:cm_seek_origin indicating the reference point used to obtain the new position.

Signature

METHODS seek IMPORTING !offset TYPE int8
                         origin TYPE ty_seek_origin DEFAULT cm_seek_origin-current.
is_input_stream
Method

Checks whether a stream is an /ork/if_io_input_stream.

  • If false, the method /ork/if_io_stream_base.METH:as_input_stream throws an exception

    • Parameters

    NameDescriptionresult
    • If true, the method /ork/if_io_stream_base.METH:as_input_stream can be used to perform a cast.

    Signature

    METHODS is_input_stream RETURNING VALUE(result) TYPE abap_bool.
    is_output_stream
    Method

    Checks whether a stream is an /ork/if_io_output_stream.

  • If false, the method /ork/if_io_stream_base.METH:as_output_stream throws an exception

    • Parameters

    NameDescriptionresult
    • If true, the method /ork/if_io_stream_base.METH:as_output_stream can be used to perform a cast.

    Signature

    METHODS is_output_stream RETURNING VALUE(result) TYPE abap_bool.
    is_inout_stream
    Method

    Checks whether a stream is an /ork/if_io_stream.

  • If false, the method /ork/if_io_stream_base.METH:as_inout_stream throws an exception

    • Parameters

    NameDescriptionresult
    • If true, the method /ork/if_io_stream_base.METH:as_inout_stream can be used to perform a cast.

    Signature

    METHODS is_inout_stream RETURNING VALUE(result) TYPE abap_bool.
    as_input_stream
    Method

    Casts and gets the current stream as an /ork/if_io_input_stream.
    Use the /ork/if_io_stream_base.METH:is_input_stream method to check beforehand whether the cast will be successful.

    Signature

    METHODS as_input_stream RETURNING VALUE(result) TYPE REF TO /ork/if_io_input_stream.
    as_output_stream
    Method

    Casts and gets the current stream as an /ork/if_io_output_stream.
    Use the /ork/if_io_stream_base.METH:is_output_stream method to check beforehand whether the cast will be successful.

    Signature

    METHODS as_output_stream RETURNING VALUE(result) TYPE REF TO /ork/if_io_output_stream.
    as_inout_stream
    Method

    Casts and gets the current stream as an /ork/if_io_stream.
    Use the /ork/if_io_stream_base.METH:is_inout_stream method to check beforehand whether the cast will be successful.

    Signature

    METHODS as_inout_stream RETURNING VALUE(result) TYPE REF TO /ork/if_io_stream.
    1 item
    Types
    ty_seek_origin
    Type

    Specifies the position in a stream to use for seeking.

    Signature

    TYPES ty_seek_origin TYPE x LENGTH 1.
    1 item
    Constants
    cm_seek_origin
    Constant

    Specifies the position in a stream to use for seeking.

    Signature

    BEGIN OF cm_seek_origin,
    Repository11 packages · 112 objects
    123 items