Struct gdnative::api::PacketPeerStream

pub struct PacketPeerStream { /* fields omitted */ }

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

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

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

Creates a new instance of this object.

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

pub fn input_buffer_max_size(&self) -> i64

pub fn output_buffer_max_size(&self) -> i64

pub fn stream_peer(&self) -> Option<Ref<StreamPeer, Shared>>

The wrapped [StreamPeer] object.

pub fn set_input_buffer_max_size(&self, max_size_bytes: i64)

pub fn set_output_buffer_max_size(&self, max_size_bytes: i64)

pub fn set_stream_peer(&self, peer: impl AsArg<StreamPeer>)

The wrapped [StreamPeer] object.

Methods from Deref<Target = 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].

Trait Implementations

impl Debug for PacketPeerStream

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

Formats the value using the given formatter.

impl Deref for PacketPeerStream

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for PacketPeerStream

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

Mutably dereferences the value.

impl GodotObject for PacketPeerStream

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 PacketPeerStream

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

impl SubClass<Object> for PacketPeerStream

impl SubClass<PacketPeer> for PacketPeerStream

impl SubClass<Reference> for PacketPeerStream