Struct gdnative::api::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.

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

pub fn get_32(&self) -> i64

pub fn get_64(&self) -> i64

pub fn get_8(&self) -> i64

pub fn get_available_bytes(&self) -> i64

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

pub fn get_double(&self) -> f64

pub fn get_float(&self) -> f64

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

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

pub fn get_u16(&self) -> i64

pub fn get_u32(&self) -> i64

pub fn get_u64(&self) -> i64

pub fn get_u8(&self) -> i64

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

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

pub fn is_big_endian_enabled(&self) -> bool

pub fn put_16(&self, value: i64)

pub fn put_32(&self, value: i64)

pub fn put_64(&self, value: i64)

pub fn put_8(&self, value: i64)

pub fn put_data(&self, data: TypedArray<u8>) -> Result<(), GodotError>

pub fn put_double(&self, value: f64)

pub fn put_float(&self, value: f64)

pub fn put_partial_data(&self, data: TypedArray<u8>) -> VariantArray<Shared>

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

pub fn put_u16(&self, value: i64)

pub fn put_u32(&self, value: i64)

pub fn put_u64(&self, value: i64)

pub fn put_u8(&self, value: i64)

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

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

pub fn set_big_endian(&self, enable: bool)

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Trait Implementations

impl Debug for StreamPeer

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

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.

impl SubClass<Object> for StreamPeer

impl SubClass<Reference> for StreamPeer

impl SubClass<StreamPeer> for StreamPeerBuffer

impl SubClass<StreamPeer> for StreamPeerGDNative

impl SubClass<StreamPeer> for StreamPeerSSL

impl SubClass<StreamPeer> for StreamPeerTCP