Struct gdnative::api::UPNPDevice

pub struct UPNPDevice { /* fields omitted */ }

core class UPNPDevice inherits Reference (reference counted).

Official documentation

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

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

UPNPDevice inherits methods from:

• Reference
• 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.

Implementations

impl UPNPDevice

Constants

pub const IGD_STATUS_DISCONNECTED: i64

pub const IGD_STATUS_HTTP_EMPTY: i64

pub const IGD_STATUS_HTTP_ERROR: i64

pub const IGD_STATUS_INVALID_CONTROL: i64

pub const IGD_STATUS_MALLOC_ERROR: i64

pub const IGD_STATUS_NO_IGD: i64

pub const IGD_STATUS_NO_URLS: i64

pub const IGD_STATUS_OK: i64

pub const IGD_STATUS_UNKNOWN_DEVICE: i64

pub const IGD_STATUS_UNKNOWN_ERROR: i64

impl UPNPDevice

pub fn new() -> Ref<UPNPDevice, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_port_mapping(
    &self,
    port: i64,
    port_internal: i64,
    desc: impl Into<GodotString>,
    proto: impl Into<GodotString>,
    duration: i64
) -> i64

pub fn delete_port_mapping(
    &self,
    port: i64,
    proto: impl Into<GodotString>
) -> i64

pub fn description_url(&self) -> GodotString

pub fn igd_control_url(&self) -> GodotString

pub fn igd_our_addr(&self) -> GodotString

pub fn igd_service_type(&self) -> GodotString

pub fn igd_status(&self) -> IgdStatus

pub fn service_type(&self) -> GodotString

pub fn is_valid_gateway(&self) -> bool

pub fn query_external_address(&self) -> GodotString

pub fn set_description_url(&self, url: impl Into<GodotString>)

pub fn set_igd_control_url(&self, url: impl Into<GodotString>)

pub fn set_igd_our_addr(&self, addr: impl Into<GodotString>)

pub fn set_igd_service_type(&self, _type: impl Into<GodotString>)

pub fn set_igd_status(&self, status: i64)

pub fn set_service_type(&self, _type: impl Into<GodotString>)

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for UPNPDevice

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

Formats the value using the given formatter.

impl Deref for UPNPDevice

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for UPNPDevice

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

Mutably dereferences the value.

impl GodotObject for UPNPDevice

type RefKind = RefCounted

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 Instanciable for UPNPDevice

fn construct() -> Ref<UPNPDevice, Unique>

impl SubClass<Object> for UPNPDevice

impl SubClass<Reference> for UPNPDevice