Struct gdnative::api::IP_Unix

pub struct IP_Unix { /* fields omitted */ }

core class IP_Unix inherits IP (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

IP_Unix inherits methods from:

• IP
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Methods from Deref<Target = IP>

pub const RESOLVER_INVALID_ID: i64

pub const RESOLVER_MAX_QUERIES: i64

pub const RESOLVER_STATUS_DONE: i64

pub const RESOLVER_STATUS_ERROR: i64

pub const RESOLVER_STATUS_NONE: i64

pub const RESOLVER_STATUS_WAITING: i64

pub const TYPE_ANY: i64

pub const TYPE_IPV4: i64

pub const TYPE_IPV6: i64

pub const TYPE_NONE: i64

pub fn clear_cache(&self, hostname: impl Into<GodotString>)

Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed.

Default Arguments

• hostname - ""

pub fn erase_resolve_item(&self, id: i64)

Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen.

pub fn get_local_addresses(&self) -> VariantArray<Shared>

Returns all of the user's current IPv4 and IPv6 addresses as an array.

pub fn get_local_interfaces(&self) -> VariantArray<Shared>

Returns all network adapters as an array.
				Each adapter is a dictionary of the form:
				[codeblock]
				{
				    "index": "1", # Interface index.
				    "name": "eth0", # Interface name.
				    "friendly": "Ethernet One", # A friendly name (might be empty).
				    "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface.
				}
				[/codeblock]

pub fn get_resolve_item_address(&self, id: i64) -> GodotString

Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]).

pub fn get_resolve_item_status(&self, id: i64) -> ResolverStatus

Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code].

pub fn resolve_hostname(
    &self,
    host: impl Into<GodotString>,
    ip_type: i64
) -> GodotString

Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code].

Default Arguments

• ip_type - 3

pub fn resolve_hostname_queue_item(
    &self,
    host: impl Into<GodotString>,
    ip_type: i64
) -> i64

Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error.

Default Arguments

• ip_type - 3

Trait Implementations

impl Debug for IP_Unix

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

Formats the value using the given formatter.

impl Deref for IP_Unix

type Target = IP

The resulting type after dereferencing.

fn deref(&self) -> &IP

Dereferences the value.

impl DerefMut for IP_Unix

fn deref_mut(&mut self) -> &mut IP

Mutably dereferences the value.

impl GodotObject for IP_Unix

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl SubClass<IP> for IP_Unix

impl SubClass<Object> for IP_Unix