Struct gio::IOStream

pub struct IOStream { /* private fields */ }

GIOStream represents an object that has both read and write streams. Generally the two streams act as separate input and output streams, but they share some common resources and state. For instance, for seekable streams, both streams may use the same position.

Examples of GIOStream objects are SocketConnection, which represents a two-way network connection; and FileIOStream, which represents a file handle opened in read-write mode.

To do the actual reading and writing you need to get the substreams with IOStreamExt::input_stream() and IOStreamExt::output_stream().

The GIOStream object owns the input and the output streams, not the other way around, so keeping the substreams alive will not keep the GIOStream object alive. If the GIOStream object is freed it will be closed, thus closing the substreams, so even if the substreams stay alive they will always return G_IO_ERROR_CLOSED for all operations.

To close a stream use IOStreamExt::close() which will close the common stream object and also the individual substreams. You can also close the substreams themselves. In most cases this only marks the substream as closed, so further I/O on it fails but common state in the GIOStream may still be open. However, some streams may support ‘half-closed’ states where one direction of the stream is actually shut down.

Operations on GIOStreams cannot be started while another operation on the GIOStream or its substreams is in progress. Specifically, an application can read from the InputStream and write to the OutputStream simultaneously (either in separate threads, or as asynchronous operations in the same thread), but an application cannot start any GIOStream operation while there is a GIOStream, GInputStream or GOutputStream operation in progress, and an application can’t start any GInputStream or GOutputStream operation while there is a GIOStream operation in progress.

This is a product of individual stream operations being associated with a given [type@GLib.MainContext] (the thread-default context at the time the operation was started), rather than entire streams being associated with a single GMainContext.

GIO may run operations on GIOStreams from other (worker) threads, and this may be exposed to application code in the behaviour of wrapper streams, such as BufferedInputStream or TlsConnection. With such wrapper APIs, application code may only run operations on the base (wrapped) stream when the wrapper stream is idle. Note that the semantics of such operations may not be well-defined due to the state the wrapper stream leaves the base stream in (though they are guaranteed not to crash).

This is an Abstract Base Class, you cannot instantiate it.

Properties

closed

Whether the stream is closed.

Readable

input-stream

The InputStream to read from.

Readable

output-stream

The OutputStream to write to.

Readable

Implements

IOStreamExt, [trait@glib::ObjectExt], IOStreamExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl IOStream

pub const NONE: Option<&'static IOStream> = None

Trait Implementations

impl Clone for IOStream

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IOStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for IOStream

type ParamSpec = ParamSpecObject

type SetValue = IOStream

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, IOStream>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IOStream

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: IOStreamImpl> IsSubclassable<T> for IOStream

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for IOStream

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for IOStream

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for IOStream

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for IOStream

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for IOStream

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IOStream

impl IsA<IOStream> for FileIOStream

impl IsA<IOStream> for SimpleIOStream

impl IsA<IOStream> for SocketConnection

impl IsA<IOStream> for TcpConnection

impl IsA<IOStream> for TlsClientConnection

impl IsA<IOStream> for TlsConnection

impl IsA<IOStream> for TlsServerConnection