Trait godot::engine::IStreamPeerExtension
pub trait IStreamPeerExtension: GodotClass + You_forgot_the_attribute__godot_api {
// Provided methods
fn init(base: Base<Self::Base>) -> Self { ... }
fn to_string(&self) -> GString { ... }
fn on_notification(&mut self, what: ObjectNotification) { ... }
fn get_property(&self, property: StringName) -> Option<Variant> { ... }
fn set_property(&mut self, property: StringName, value: Variant) -> bool { ... }
unsafe fn get_data(
&mut self,
r_buffer: *mut u8,
r_bytes: i32,
r_received: *mut i32
) -> Error { ... }
unsafe fn get_partial_data(
&mut self,
r_buffer: *mut u8,
r_bytes: i32,
r_received: *mut i32
) -> Error { ... }
unsafe fn put_data(
&mut self,
p_data: *const u8,
p_bytes: i32,
r_sent: *mut i32
) -> Error { ... }
unsafe fn put_partial_data(
&mut self,
p_data: *const u8,
p_bytes: i32,
r_sent: *mut i32
) -> Error { ... }
fn get_available_bytes(&self) -> i32 { ... }
}
Expand description
Virtual methods for class StreamPeerExtension
.
These methods represent constructors (init
) or callbacks invoked by the engine.
Provided Methods§
fn init(base: Base<Self::Base>) -> Self
fn init(base: Base<Self::Base>) -> Self
Godot constructor, accepting an injected base
object.
base
refers to the base instance of the class, which can either be stored in a Base<T>
field or discarded.
This method returns a fully-constructed instance, which will then be moved into a Gd<T>
pointer.
If the class has a #[class(init)]
attribute, this method will be auto-generated and must not be overridden.
fn to_string(&self) -> GString
fn to_string(&self) -> GString
String representation of the Godot instance.
Override this method to define how the instance is represented as a string.
Used by impl Display for Gd<T>
, as well as str()
and print()
in GDScript.
fn on_notification(&mut self, what: ObjectNotification)
fn on_notification(&mut self, what: ObjectNotification)
Called when the object receives a Godot notification.
The type of notification can be identified through what
. The enum is designed to hold all possible NOTIFICATION_*
constants that the current class can handle. However, this is not validated in Godot, so an enum variant Unknown
exists
to represent integers out of known constants (mistakes or future additions).
This method is named _notification
in Godot, but on_notification
in Rust. To send notifications, use the
Object::notify
method.
See also in Godot docs:
fn get_property(&self, property: StringName) -> Option<Variant>
fn get_property(&self, property: StringName) -> Option<Variant>
Called whenever get()
is called or Godot gets the value of a property.
Should return the given property
’s value as Some(value)
, or None
if the property should be handled normally.
See also in Godot docs:
fn set_property(&mut self, property: StringName, value: Variant) -> bool
fn set_property(&mut self, property: StringName, value: Variant) -> bool
Called whenever Godot set()
is called or Godot sets the value of a property.
Should set property
to the given value
and return true
, or return false
to indicate the property
should be handled normally.
See also in Godot docs:
unsafe fn get_data(
&mut self,
r_buffer: *mut u8,
r_bytes: i32,
r_received: *mut i32
) -> Error
unsafe fn get_data( &mut self, r_buffer: *mut u8, r_bytes: i32, r_received: *mut i32 ) -> Error
§Safety
This method has automatically been marked unsafe
because it accepts raw pointers as parameters.
If Godot does not document any safety requirements, make sure you understand the underlying semantics.
unsafe fn get_partial_data(
&mut self,
r_buffer: *mut u8,
r_bytes: i32,
r_received: *mut i32
) -> Error
unsafe fn get_partial_data( &mut self, r_buffer: *mut u8, r_bytes: i32, r_received: *mut i32 ) -> Error
§Safety
This method has automatically been marked unsafe
because it accepts raw pointers as parameters.
If Godot does not document any safety requirements, make sure you understand the underlying semantics.
unsafe fn put_data(
&mut self,
p_data: *const u8,
p_bytes: i32,
r_sent: *mut i32
) -> Error
unsafe fn put_data( &mut self, p_data: *const u8, p_bytes: i32, r_sent: *mut i32 ) -> Error
§Safety
This method has automatically been marked unsafe
because it accepts raw pointers as parameters.
If Godot does not document any safety requirements, make sure you understand the underlying semantics.
unsafe fn put_partial_data(
&mut self,
p_data: *const u8,
p_bytes: i32,
r_sent: *mut i32
) -> Error
unsafe fn put_partial_data( &mut self, p_data: *const u8, p_bytes: i32, r_sent: *mut i32 ) -> Error
§Safety
This method has automatically been marked unsafe
because it accepts raw pointers as parameters.
If Godot does not document any safety requirements, make sure you understand the underlying semantics.