Memory-managed wrapper type.

Construct a IOChannel struct initialized to zero.

A convenience alias for Nothing :: Maybe IOChannel.

Close an IO channel. Any pending data to be written will be flushed, ignoring errors. The channel will not be freed until the last reference is dropped using iOChannelUnref.

Converts an errno error number to a IOChannelError.

No description available in the introspection data.

Flushes the write buffer for the GIOChannel.

This function returns a IOCondition depending on whether there is data to be read/space to write data in the internal buffers in the IOChannel. Only the flags IOConditionIn and IOConditionOut may be set.

Gets the buffer size.

Returns whether channel is buffered.

Returns whether the file/socket/whatever associated with channel will be closed when channel receives its final unref and is destroyed. The default value of this is True for channels created by g_io_channel_new_file (), and False for all other channels.

Gets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The encoding Nothing makes the channel safe for binary data.

Gets the current flags for a IOChannel, including read-only flags such as IOFlagsIsReadable.

The values of the flags IOFlagsIsReadable and IOFlagsIsWritable are cached for internal use by the channel when it is created. If they should change at some later point (e.g. partial shutdown of a socket with the UNIX shutdown() function), the user should immediately call iOChannelGetFlags to update the internal values of these flags.

This returns the string that IOChannel uses to determine where in the file a line break occurs. A value of Nothing indicates autodetection.

Initializes a IOChannel struct.

This is called by each of the above functions when creating a IOChannel, and so is not often needed by the application programmer (unless you are creating a new type of IOChannel).

Open a file filename as a IOChannel using mode mode. This channel will be closed when the last reference to it is dropped, so there is no need to call iOChannelClose (though doing so will not cause problems, as long as no attempt is made to access the channel after it is closed).

Reads data from a IOChannel.

Replacement for iOChannelRead with the new API.

Reads a line, including the terminating character(s), from a IOChannel into a newly-allocated string. strReturn will contain allocated memory if the return is IOStatusNormal.

Reads all the remaining data from the file.

Reads a Unicode character from channel. This function cannot be called on a channel with Nothing encoding.

Increments the reference count of a IOChannel.

Sets the current position in the IOChannel, similar to the standard library function fseek().

Replacement for iOChannelSeek with the new API.

Sets the buffer size.

The buffering state can only be set if the channel's encoding is Nothing. For any other encoding, the channel must be buffered.

A buffered channel can only be set unbuffered if the channel's internal buffers have been flushed. Newly created channels or channels which have returned IOStatusEof not require such a flush. For write-only channels, a call to g_io_channel_flush () is sufficient. For all other channels, the buffers may be flushed by a call to g_io_channel_seek_position (). This includes the possibility of seeking with seek type SeekTypeCur and an offset of zero. Note that this means that socket-based channels cannot be set unbuffered once they have had data read from them.

On unbuffered channels, it is safe to mix read and write calls from the new and old APIs, if this is necessary for maintaining old code.

The default state of the channel is buffered.

Whether to close the channel on the final unref of the IOChannel data structure. The default value of this is True for channels created by g_io_channel_new_file (), and False for all other channels.

Setting this flag to True for a channel you have already closed can cause problems when the final reference to the IOChannel is dropped.

Sets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The default encoding for the external file is UTF-8.

The encoding Nothing is safe to use with binary data.

The encoding can only be set if one of the following conditions is true:

• The channel was just created, and has not been written to or read from yet.
• The channel is write-only.
• The channel is a file, and the file pointer was just repositioned by a call to iOChannelSeekPosition. (This flushes all the internal buffers.)
• The current encoding is Nothing or UTF-8.
• One of the (new API) read functions has just returned IOStatusEof (or, in the case of iOChannelReadToEnd, IOStatusNormal).
• One of the functions iOChannelReadChars or iOChannelReadUnichar has returned IOStatusAgain or IOStatusError. This may be useful in the case of ConvertErrorIllegalSequence. Returning one of these statuses from iOChannelReadLine, g_io_channel_read_line_string(), or iOChannelReadToEnd does not guarantee that the encoding can be changed.

Channels which do not meet one of the above conditions cannot call iOChannelSeekPosition with an offset of SeekTypeCur, and, if they are "seekable", cannot call iOChannelWriteChars after calling one of the API "read" functions.

Sets the (writeable) flags in channel to (flags & IOFlagsSetMask).

This sets the string that IOChannel uses to determine where in the file a line break occurs.

Close an IO channel. Any pending data to be written will be flushed if flush is True. The channel will not be freed until the last reference is dropped using iOChannelUnref.

Returns the file descriptor of the IOChannel.

On Windows this function returns the file descriptor or socket of the IOChannel.

Creates a new IOChannel given a file descriptor. On UNIX systems this works for plain files, pipes, and sockets.

The returned IOChannel has a reference count of 1.

The default encoding for IOChannel is UTF-8. If your application is reading output from a command using via pipe, you may need to set the encoding to the encoding of the current locale (see getCharset) with the iOChannelSetEncoding function. By default, the fd passed will not be closed when the final reference to the IOChannel data structure is dropped.

If you want to read raw binary data without interpretation, then call the iOChannelSetEncoding function with Nothing for the encoding argument.

This function is available in GLib on Windows, too, but you should avoid using it on Windows. The domain of file descriptors and sockets overlap. There is no way for GLib to know which one you mean in case the argument you pass to this function happens to be both a valid file descriptor and socket. If that happens a warning is issued, and GLib assumes that it is the file descriptor you mean.

Decrements the reference count of a IOChannel.

Writes data to a IOChannel.

Replacement for iOChannelWrite with the new API.

On seekable channels with encodings other than Nothing or UTF-8, generic mixing of reading and writing is not allowed. A call to g_io_channel_write_chars () may only be made on a channel from which data has been read in the cases described in the documentation for g_io_channel_set_encoding ().

Writes a Unicode character to channel. This function cannot be called on a channel with Nothing encoding.