Struct gio::SocketConnection

#[repr(transparent)]
pub struct SocketConnection { /* private fields */ }

SocketConnection is a IOStream for a connected socket. They can be created either by SocketClient when connecting to a host, or by SocketListener when accepting a new client.

The type of the SocketConnection object returned from these calls depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a TcpConnection.

Choosing what type of object to construct is done with the socket connection factory, and it is possible for 3rd parties to register custom socket connection types for specific combination of socket family/type/protocol using factory_register_type().

To close a SocketConnection, use IOStreamExt::close(). Closing both substreams of the IOStream separately will not close the underlying Socket.

Properties

socket

Readable | Writeable | Construct Only

IOStream

closed

Readable

input-stream

Readable

output-stream

Readable

Implements

SocketConnectionExt, IOStreamExt, glib::ObjectExt, IOStreamExtManual

Implementations

impl SocketConnection

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

pub fn factory_lookup_type( family: SocketFamily, type_: SocketType, protocol_id: i32 ) -> Type

Looks up the GType to be used when creating socket connections on sockets with the specified family, type_ and protocol_id.

If no type is registered, the SocketConnection base type is returned.

family

a SocketFamily

type_

a SocketType

protocol_id

a protocol id

Returns

a GType

pub fn factory_register_type( g_type: Type, family: SocketFamily, type_: SocketType, protocol: i32 )

Looks up the GType to be used when creating socket connections on sockets with the specified family, type_ and protocol.

If no type is registered, the SocketConnection base type is returned.

g_type

a GType, inheriting from G_TYPE_SOCKET_CONNECTION

family

a SocketFamily

type_

a SocketType

protocol

a protocol id

Trait Implementations

impl Clone for SocketConnection

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 SocketConnection

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

Formats the value using the given formatter.

impl Display for SocketConnection

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

Formats the value using the given formatter.

impl HasParamSpec for SocketConnection

type ParamSpec = ParamSpecObject

type SetValue = SocketConnection

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SocketConnection

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 Ord for SocketConnection

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 SocketConnection

type Parent = IOStream

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

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 SocketConnection

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 SocketConnection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SocketConnection

impl IsA<IOStream> for SocketConnection

impl IsA<SocketConnection> for TcpConnection