Struct godot::engine::StreamPeer

#[repr(C)]
pub struct StreamPeer { /* private fields */ }

Expand description

Godot class StreamPeer.

Inherits RefCounted.

Related symbols:

stream_peer: sidecar module with related enum/flag types
IStreamPeer: virtual methods

§Not instantiable

This class cannot be constructed. Obtain Gd<StreamPeer> instances via Godot APIs.

Implementations§

§

impl StreamPeer

pub fn put_data(&mut self, data: PackedByteArray) -> Error

pub fn put_partial_data(&mut self, data: PackedByteArray) -> Array<Variant>

pub fn get_data(&mut self, bytes: i32) -> Array<Variant>

pub fn get_partial_data(&mut self, bytes: i32) -> Array<Variant>

pub fn get_available_bytes(&self) -> i32

pub fn set_big_endian(&mut self, enable: bool)

pub fn is_big_endian_enabled(&self) -> bool

pub fn put_8(&mut self, value: i8)

pub fn put_u8(&mut self, value: u8)

pub fn put_16(&mut self, value: i16)

pub fn put_u16(&mut self, value: u16)

pub fn put_32(&mut self, value: i32)

pub fn put_u32(&mut self, value: u32)

pub fn put_64(&mut self, value: i64)

pub fn put_u64(&mut self, value: u64)

pub fn put_float(&mut self, value: f32)

pub fn put_double(&mut self, value: f64)

pub fn put_string(&mut self, value: GString)

pub fn put_utf8_string(&mut self, value: GString)

pub fn put_var(&mut self, value: Variant)

pub fn put_var_ex(&mut self, value: Variant) -> ExPutVar<'_>

pub fn get_8(&mut self) -> i8

pub fn get_u8(&mut self) -> u8

pub fn get_16(&mut self) -> i16

pub fn get_u16(&mut self) -> u16

pub fn get_32(&mut self) -> i32

pub fn get_u32(&mut self) -> u32

pub fn get_64(&mut self) -> i64

pub fn get_u64(&mut self) -> u64

pub fn get_float(&mut self) -> f32

pub fn get_double(&mut self) -> f64

pub fn get_string(&mut self) -> GString

pub fn get_string_ex(&mut self) -> ExGetString<'_>

pub fn get_utf8_string(&mut self) -> GString

pub fn get_utf8_string_ex(&mut self) -> ExGetUtf8String<'_>

pub fn get_var(&mut self) -> Variant

pub fn get_var_ex(&mut self) -> ExGetVar<'_>

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant] ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant] ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant] ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant] ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: Variant)

pub fn callv( &mut self, method: StringName, arg_array: Array<Variant> ) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32 ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32 ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.