Struct gdnative::api::PacketPeerUDP

pub struct PacketPeerUDP { /* fields omitted */ }

core class PacketPeerUDP inherits PacketPeer (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

PacketPeerUDP inherits methods from:

• PacketPeer
• 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 PacketPeerUDP

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

Creates a new instance of this object.

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

pub fn close(&self)

pub fn connect_to_host(
    &self,
    host: impl Into<GodotString>,
    port: i64
) -> Result<(), GodotError>

pub fn get_packet_ip(&self) -> GodotString

pub fn get_packet_port(&self) -> i64

pub fn is_connected_to_host(&self) -> bool

pub fn is_listening(&self) -> bool

pub fn join_multicast_group(
    &self,
    multicast_address: impl Into<GodotString>,
    interface_name: impl Into<GodotString>
) -> Result<(), GodotError>

pub fn leave_multicast_group(
    &self,
    multicast_address: impl Into<GodotString>,
    interface_name: impl Into<GodotString>
) -> Result<(), GodotError>

pub fn listen(
    &self,
    port: i64,
    bind_address: impl Into<GodotString>,
    recv_buf_size: i64
) -> Result<(), GodotError>

pub fn set_broadcast_enabled(&self, enabled: bool)

pub fn set_dest_address(
    &self,
    host: impl Into<GodotString>,
    port: i64
) -> Result<(), GodotError>

pub fn wait(&self) -> Result<(), GodotError>

Methods from Deref<Target = PacketPeer>

pub fn get_available_packet_count(&self) -> i64

pub fn encode_buffer_max_size(&self) -> i64

pub fn get_packet(&self) -> TypedArray<u8>

pub fn get_packet_error(&self) -> Result<(), GodotError>

pub fn get_var(&self, allow_objects: bool) -> Variant

pub fn is_object_decoding_allowed(&self) -> bool

pub fn put_packet(&self, buffer: TypedArray<u8>) -> Result<(), GodotError>

pub fn put_var(
    &self,
    var: impl OwnedToVariant,
    full_objects: bool
) -> Result<(), GodotError>

pub fn set_allow_object_decoding(&self, enable: bool)

pub fn set_encode_buffer_max_size(&self, max_size: i64)

Trait Implementations

impl Debug for PacketPeerUDP

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

Formats the value using the given formatter.

impl Deref for PacketPeerUDP

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for PacketPeerUDP

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

Mutably dereferences the value.

impl GodotObject for PacketPeerUDP

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 PacketPeerUDP

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

impl SubClass<Object> for PacketPeerUDP

impl SubClass<PacketPeer> for PacketPeerUDP

impl SubClass<Reference> for PacketPeerUDP