Struct gio::IOStream

#[repr(transparent)]
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 IOStream 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 IOStream object owns the input and the output streams, not the other way around, so keeping the substreams alive will not keep the IOStream object alive. If the IOStream object is freed it will be closed, thus closing the substreams, so even if the substreams stay alive they will always return IOErrorEnum::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 IOStream 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 IOStream 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 IOStream operation while there is a IOStream, InputStream or OutputStream operation in progress, and an application can’t start any InputStream or OutputStream operation while there is a IOStream operation in progress.

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

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.

Implements

IOStreamExt, glib::ObjectExt, IOStreamExtManual

Implementations

impl IOStream

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

Trait Implementations

impl Clone for IOStream

fn clone(&self) -> Self

Returns a copy of the value.

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 Display for IOStream

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

Formats the value using the given formatter.

impl Hash for IOStream

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

Feeds this value into the given Hasher.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

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

This method tests for self and other values to be equal, and is used by ==.

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>

This method returns an ordering between self and other values if one exists.

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