/ 
RDF-Cowl-1.0.0
River stage zero No dependents
/ RDF::Cowl::Lib::Gen::Class::UOStream

NAME

RDF::Cowl::Lib::Gen::Class::UOStream - Generated docs for RDF::Cowl::Ulib::UOStream

VERSION

version 1.0.0

MAIN MODULE

RDF::Cowl::Ulib::UOStream

METHODS

deinit

Signature:

$self->deinit()

Params:

UOStream $stream

Documentation:

Deinitializes the stream, releasing any reserved resource.

@param stream Output stream.
@return Return code.

    C function name: uostream_deinit

flush

Signature:

$self->flush()

Params:

UOStream $stream

Documentation:

Flushes the stream, writing any buffered data.

@param stream Output stream.
@return Return code.

    C function name: uostream_flush

std

Signature:

$self->std()

Documentation:

Returns a stream that writes to the standard output.

@return Standard output stream.

    C function name: uostream_std

stderr

Signature:

$self->stderr()

Documentation:

Returns a stream that writes to the standard error.

@return Standard error stream.

    C function name: uostream_stderr

null

Signature:

$self->null()

Documentation:

Returns a stream that discards its output.

@return Null output stream.

    C function name: uostream_null

to_path

Signature:

$self->to_path(Str $path)

Params:

UOStream $stream 
Str $path

Documentation:

Initializes a stream that writes to the file at the specified path.

@param stream Output stream.
@param path Path to the file to write to.
@return Return code.

    C function name: uostream_to_path

to_file

Signature:

$self->to_file(InstanceOf["FFI::C::File"] $file)

Params:

UOStream $stream 
InstanceOf["FFI::C::File"] $file

Documentation:

Initializes a stream that writes to the specified file.

@param stream Output stream.
@param file The output file.
@return Return code.

@note You are responsible for closing the file.

    C function name: uostream_to_file

to_strbuf

Signature:

$self->to_strbuf(UStrBuf $buf)

Params:

UOStream $stream 
UStrBuf $buf

Documentation:

Initializes a stream that writes to the specified string buffer.

@param stream Output stream.
@param buf The output buffer.
@return Return code.

@note If `buf` is NULL, the stream will allocate a new string buffer and set it as its context.
      In this case, the string buffer will be deinitialized when calling `uostream_deinit`.

    C function name: uostream_to_strbuf

to_multi

Signature:

$self->to_multi()

Params:

UOStream $stream

Documentation:

Initializes a stream that writes to multiple substreams.

@param stream Output stream.
@return Return code.

@note Multi-streams behave as follows:
      - In case of error of any of the substreams, only the first detected error code
        is returned. It is your responsibility to check the state of each individual
        substream if that is important for your use case.
      - The reported written bytes are the maximum bytes written by any of the underlying
        substreams.
      - Calling `uostream_deinit` deinitializes all substreams.

    C function name: uostream_to_multi

add_substream

Signature:

$self->add_substream(UOStream $other)

Params:

UOStream $stream 
UOStream $other

Documentation:

Adds a new output stream to the specified multi-stream.

@param stream Output stream.
@param other Stream to add.
@return Return code.

@note Both streams must have been initialized beforehand, and `stream`
      must have been initialized via `uostream_to_multi`.

    C function name: uostream_add_substream

AUTHOR

Zakariyya Mughal <zmughal@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2024 by Auto-Parallel Technologies, Inc..

This is free software, licensed under Eclipse Public License - v 2.0.