gio/auto/inet_socket_address.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{ffi, InetAddress, SocketAddress, SocketConnectable};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// An IPv4 or IPv6 socket address. That is, the combination of a
/// [`InetAddress`][crate::InetAddress] and a port number.
///
/// In UNIX terms, `GInetSocketAddress` corresponds to a
/// [`struct sockaddr_in` or `struct sockaddr_in6`](man:sockaddr(3type)).
///
/// ## Properties
///
///
/// #### `address`
/// The address.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `flowinfo`
/// The `sin6_flowinfo` field, for IPv6 addresses.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `port`
/// The port.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `scope-id`
/// The `sin6_scope_id` field, for IPv6 addresses.
///
/// Readable | Writeable | Construct Only
/// <details><summary><h4>SocketAddress</h4></summary>
///
///
/// #### `family`
/// The family of the socket address.
///
/// Readable
/// </details>
///
/// # Implements
///
/// [`InetSocketAddressExt`][trait@crate::prelude::InetSocketAddressExt], [`SocketAddressExt`][trait@crate::prelude::SocketAddressExt], [`trait@glib::ObjectExt`], [`SocketConnectableExt`][trait@crate::prelude::SocketConnectableExt]
#[doc(alias = "GInetSocketAddress")]
pub struct InetSocketAddress(Object<ffi::GInetSocketAddress, ffi::GInetSocketAddressClass>) @extends SocketAddress, @implements SocketConnectable;
match fn {
type_ => || ffi::g_inet_socket_address_get_type(),
}
}
impl InetSocketAddress {
pub const NONE: Option<&'static InetSocketAddress> = None;
/// Creates a new #GInetSocketAddress for @address and @port.
/// ## `address`
/// a #GInetAddress
/// ## `port`
/// a port number
///
/// # Returns
///
/// a new #GInetSocketAddress
#[doc(alias = "g_inet_socket_address_new")]
pub fn new(address: &impl IsA<InetAddress>, port: u16) -> InetSocketAddress {
unsafe {
SocketAddress::from_glib_full(ffi::g_inet_socket_address_new(
address.as_ref().to_glib_none().0,
port,
))
.unsafe_cast()
}
}
/// Creates a new #GInetSocketAddress for @address and @port.
///
/// If @address is an IPv6 address, it can also contain a scope ID
/// (separated from the address by a `%`).
/// ## `address`
/// the string form of an IP address
/// ## `port`
/// a port number
///
/// # Returns
///
/// a new #GInetSocketAddress,
/// or [`None`] if @address cannot be parsed.
#[doc(alias = "g_inet_socket_address_new_from_string")]
#[doc(alias = "new_from_string")]
pub fn from_string(address: &str, port: u32) -> Option<InetSocketAddress> {
unsafe {
Option::<SocketAddress>::from_glib_full(ffi::g_inet_socket_address_new_from_string(
address.to_glib_none().0,
port,
))
.map(|o| o.unsafe_cast())
}
}
}
unsafe impl Send for InetSocketAddress {}
unsafe impl Sync for InetSocketAddress {}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::InetSocketAddress>> Sealed for T {}
}
/// Trait containing all [`struct@InetSocketAddress`] methods.
///
/// # Implementors
///
/// [`InetSocketAddress`][struct@crate::InetSocketAddress], [`ProxyAddress`][struct@crate::ProxyAddress]
pub trait InetSocketAddressExt: IsA<InetSocketAddress> + sealed::Sealed + 'static {
/// Gets @self's #GInetAddress.
///
/// # Returns
///
/// the #GInetAddress for @self, which must be
/// g_object_ref()'d if it will be stored
#[doc(alias = "g_inet_socket_address_get_address")]
#[doc(alias = "get_address")]
fn address(&self) -> InetAddress {
unsafe {
from_glib_none(ffi::g_inet_socket_address_get_address(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the `sin6_flowinfo` field from @self,
/// which must be an IPv6 address.
///
/// # Returns
///
/// the flowinfo field
#[doc(alias = "g_inet_socket_address_get_flowinfo")]
#[doc(alias = "get_flowinfo")]
fn flowinfo(&self) -> u32 {
unsafe { ffi::g_inet_socket_address_get_flowinfo(self.as_ref().to_glib_none().0) }
}
/// Gets @self's port.
///
/// # Returns
///
/// the port for @self
#[doc(alias = "g_inet_socket_address_get_port")]
#[doc(alias = "get_port")]
fn port(&self) -> u16 {
unsafe { ffi::g_inet_socket_address_get_port(self.as_ref().to_glib_none().0) }
}
/// Gets the `sin6_scope_id` field from @self,
/// which must be an IPv6 address.
///
/// # Returns
///
/// the scope id field
#[doc(alias = "g_inet_socket_address_get_scope_id")]
#[doc(alias = "get_scope_id")]
#[doc(alias = "scope-id")]
fn scope_id(&self) -> u32 {
unsafe { ffi::g_inet_socket_address_get_scope_id(self.as_ref().to_glib_none().0) }
}
}
impl<O: IsA<InetSocketAddress>> InetSocketAddressExt for O {}