Struct gdnative::api::PacketPeer

pub struct PacketPeer { /* fields omitted */ }

core class PacketPeer 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

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

pub fn get_available_packet_count(&self) -> i64

Returns the number of packets currently available in the ring-buffer.

pub fn encode_buffer_max_size(&self) -> i64

Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations.
			The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY].

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

Gets a raw packet.

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

Returns the error state of the last packet received (via [method get_packet] and [method get_var]).

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

Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed.
				[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

Default Arguments

• allow_objects - false

pub fn is_object_decoding_allowed(&self) -> bool

[i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead.
			If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var].
			[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

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

Sends a raw packet.

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

Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code).

Default Arguments

• full_objects - false

pub fn set_allow_object_decoding(&self, enable: bool)

[i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead.
			If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var].
			[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn set_encode_buffer_max_size(&self, max_size: i64)

Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations.
			The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY].

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 PacketPeer

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

Formats the value using the given formatter.

impl Deref for PacketPeer

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for PacketPeer

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

Mutably dereferences the value.

impl GodotObject for PacketPeer

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 SubClass<Object> for PacketPeer

impl SubClass<PacketPeer> for NetworkedMultiplayerENet

impl SubClass<PacketPeer> for WebRTCMultiplayer

impl SubClass<PacketPeer> for MultiplayerPeerGDNative

impl SubClass<PacketPeer> for NetworkedMultiplayerPeer

impl SubClass<PacketPeer> for PacketPeerStream

impl SubClass<PacketPeer> for WebSocketMultiplayerPeer

impl SubClass<PacketPeer> for PacketPeerUDP

impl SubClass<PacketPeer> for WebSocketClient

impl SubClass<PacketPeer> for WebRTCDataChannelGDNative

impl SubClass<PacketPeer> for PacketPeerDTLS

impl SubClass<PacketPeer> for WebSocketPeer

impl SubClass<PacketPeer> for WebRTCDataChannel

impl SubClass<PacketPeer> for PacketPeerGDNative

impl SubClass<PacketPeer> for WebSocketServer

impl SubClass<Reference> for PacketPeer