Struct StreamPeerTls
#[repr(C)]pub struct StreamPeerTls { /* private fields */ }
Expand description
Godot class StreamPeerTLS.
Inherits StreamPeer
.
Related symbols:
stream_peer_tls
: sidecar module with related enum/flag typesIStreamPeerTls
: virtual methods
See also Godot docs for StreamPeerTLS
.
§Construction
This class is reference-counted. You can create a new instance using StreamPeerTls::new_gd()
.
Implementations§
§impl StreamPeerTls
impl StreamPeerTls
pub fn poll(&mut self)
pub fn accept_stream( &mut self, stream: impl AsArg<Option<Gd<StreamPeer>>>, server_options: impl AsArg<Option<Gd<TlsOptions>>>, ) -> Error
pub fn connect_to_stream(
&mut self,
stream: impl AsArg<Option<Gd<StreamPeer>>>,
common_name: impl AsArg<GString>,
) -> Error
pub fn connect_to_stream( &mut self, stream: impl AsArg<Option<Gd<StreamPeer>>>, common_name: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::connect_to_stream_ex
and its builder methods. See the book for detailed usage instructions.
pub fn connect_to_stream_ex<'a>( &'a mut self, stream: impl AsArg<Option<Gd<StreamPeer>>> + 'a, common_name: impl AsArg<GString> + 'a, ) -> ExConnectToStream<'a>
pub fn get_status(&self) -> Status
pub fn get_stream(&self) -> Option<Gd<StreamPeer>>
pub fn disconnect_from_stream(&mut self)
Methods from Deref<Target = StreamPeer>§
pub fn put_data(&mut self, data: &PackedArray<u8>) -> Error
pub fn put_partial_data(&mut self, data: &PackedArray<u8>) -> 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_half(&mut self, value: f32)
pub fn put_float(&mut self, value: f32)
pub fn put_double(&mut self, value: f64)
pub fn put_string(&mut self, value: impl AsArg<GString>)
pub fn put_utf8_string(&mut self, value: impl AsArg<GString>)
pub fn put_var(&mut self, value: &Variant)
pub fn put_var(&mut self, value: &Variant)
To set the default parameters, use Self::put_var_ex
and its builder methods. See the book for detailed usage instructions.
pub fn put_var_ex<'a>(&'a mut self, value: &'a Variant) -> ExPutVar<'a>
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_half(&mut self) -> f32
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(&mut self) -> GString
To set the default parameters, use Self::get_string_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_string_ex<'a>(&'a mut self) -> ExGetString<'a>
pub fn get_utf8_string(&mut self) -> GString
pub fn get_utf8_string(&mut self) -> GString
To set the default parameters, use Self::get_utf8_string_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_utf8_string_ex<'a>(&'a mut self) -> ExGetUtf8String<'a>
pub fn get_var(&mut self) -> Variant
pub fn get_var(&mut self) -> Variant
To set the default parameters, use Self::get_var_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_var_ex<'a>(&'a mut self) -> ExGetVar<'a>
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<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: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> 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: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
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.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for StreamPeerTls
impl Bounds for StreamPeerTls
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for StreamPeerTls
impl Debug for StreamPeerTls
§impl Deref for StreamPeerTls
impl Deref for StreamPeerTls
§type Target = StreamPeer
type Target = StreamPeer
§fn deref(&self) -> &<StreamPeerTls as Deref>::Target
fn deref(&self) -> &<StreamPeerTls as Deref>::Target
§impl DerefMut for StreamPeerTls
impl DerefMut for StreamPeerTls
§fn deref_mut(&mut self) -> &mut <StreamPeerTls as Deref>::Target
fn deref_mut(&mut self) -> &mut <StreamPeerTls as Deref>::Target
§impl GodotClass for StreamPeerTls
impl GodotClass for StreamPeerTls
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§type Base = StreamPeer
type Base = StreamPeer
T
. This is always a Godot engine class.§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for StreamPeerTls
impl Inherits<Object> for StreamPeerTls
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<RefCounted> for StreamPeerTls
impl Inherits<RefCounted> for StreamPeerTls
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<StreamPeer> for StreamPeerTls
impl Inherits<StreamPeer> for StreamPeerTls
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for StreamPeerTls
impl WithSignals for StreamPeerTls
§type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
impl GodotDefault for StreamPeerTls
Auto Trait Implementations§
impl Freeze for StreamPeerTls
impl RefUnwindSafe for StreamPeerTls
impl !Send for StreamPeerTls
impl !Sync for StreamPeerTls
impl Unpin for StreamPeerTls
impl UnwindSafe for StreamPeerTls
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more