Struct gdnative_bindings_lily::StreamPeer

pub struct StreamPeer { /* fields omitted */ }

core class StreamPeer inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

Class hierarchy

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

pub fn get_16(&self) -> i64

Gets a signed 16-bit value from the stream.

pub fn get_32(&self) -> i64

Gets a signed 32-bit value from the stream.

pub fn get_64(&self) -> i64

Gets a signed 64-bit value from the stream.

pub fn get_8(&self) -> i64

Gets a signed byte from the stream.

pub fn get_available_bytes(&self) -> i64

Returns the amount of bytes this StreamPeer has available.

pub fn get_data(&self, bytes: i64) -> VariantArray

Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the bytes argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array.

pub fn get_double(&self) -> f64

Gets a double-precision float from the stream.

pub fn get_float(&self) -> f64

Gets a single-precision float from the stream.

pub fn get_partial_data(&self, bytes: i64) -> VariantArray

Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the “bytes” argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array.

pub fn get_string(&self, bytes: i64) -> GodotString

Gets a string with byte-length bytes from the stream. If bytes is negative (default) the length will be read from the stream using the reverse process of [method put_string].

Default Arguments

• bytes - -1

pub fn get_u16(&self) -> i64

Gets an unsigned 16-bit value from the stream.

pub fn get_u32(&self) -> i64

Gets an unsigned 32-bit value from the stream.

pub fn get_u64(&self) -> i64

Gets an unsigned 64-bit value from the stream.

pub fn get_u8(&self) -> i64

Gets an unsigned byte from the stream.

pub fn get_utf8_string(&self, bytes: i64) -> GodotString

Gets an UTF-8 string with byte-length bytes from the stream (this decodes the string sent as UTF-8). If bytes is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string].

Default Arguments

• bytes - -1

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

Gets a Variant from the stream. If allow_objects is true, decoding objects is allowed. Warning: 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_big_endian_enabled(&self) -> bool

If true, this StreamPeer will using big-endian format for encoding and decoding.

pub fn put_16(&self, value: i64)

Puts a signed 16-bit value into the stream.

pub fn put_32(&self, value: i64)

Puts a signed 32-bit value into the stream.

pub fn put_64(&self, value: i64)

Puts a signed 64-bit value into the stream.

pub fn put_8(&self, value: i64)

Puts a signed byte into the stream.

pub fn put_data(&self, data: ByteArray) -> GodotResult

Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code.

pub fn put_double(&self, value: f64)

Puts a double-precision float into the stream.

pub fn put_float(&self, value: f64)

Puts a single-precision float into the stream.

pub fn put_partial_data(&self, data: ByteArray) -> VariantArray

Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent.

pub fn put_string(&self, value: impl Into<GodotString>)

Sample code is GDScript unless otherwise noted.

Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. Note: To put an ASCII string without prepending its size, you can use [method put_data]:

put_data("Hello world".to_ascii())

pub fn put_u16(&self, value: i64)

Puts an unsigned 16-bit value into the stream.

pub fn put_u32(&self, value: i64)

Puts an unsigned 32-bit value into the stream.

pub fn put_u64(&self, value: i64)

Puts an unsigned 64-bit value into the stream.

pub fn put_u8(&self, value: i64)

Puts an unsigned byte into the stream.

pub fn put_utf8_string(&self, value: impl Into<GodotString>)

Sample code is GDScript unless otherwise noted.

Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. Note: To put an UTF-8 string without prepending its size, you can use [method put_data]:

put_data("Hello world".to_utf8())

pub fn put_var(&self, value: impl OwnedToVariant, full_objects: bool)

Puts a Variant into the stream. If full_objects is true encoding objects is allowed (and can potentially include code).

Default Arguments

• full_objects - false

pub fn set_big_endian(&self, enable: bool)

If true, this StreamPeer will using big-endian format for encoding and decoding.

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 StreamPeer

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

Formats the value using the given formatter.

impl Deref for StreamPeer

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for StreamPeer

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

Mutably dereferences the value.

impl GodotObject for StreamPeer

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Sealed for StreamPeer

impl SubClass<Object> for StreamPeer

impl SubClass<Reference> for StreamPeer

impl SubClass<StreamPeer> for StreamPeerTCP

impl SubClass<StreamPeer> for StreamPeerSSL

impl SubClass<StreamPeer> for StreamPeerGDNative

impl SubClass<StreamPeer> for StreamPeerBuffer