Struct gdnative::api::WebRTCDataChannelGDNative

pub struct WebRTCDataChannelGDNative { /* fields omitted */ }

core class WebRTCDataChannelGDNative inherits WebRTCDataChannel (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

WebRTCDataChannelGDNative inherits methods from:

• WebRTCDataChannel
• PacketPeer
• 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 WebRTCDataChannelGDNative

pub fn new() -> Ref<WebRTCDataChannelGDNative, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

Methods from Deref<Target = WebRTCDataChannel>

pub const STATE_CLOSED: i64

pub const STATE_CLOSING: i64

pub const STATE_CONNECTING: i64

pub const STATE_OPEN: i64

pub const WRITE_MODE_BINARY: i64

pub const WRITE_MODE_TEXT: i64

pub fn close(&self)

pub fn get_id(&self) -> i64

pub fn get_label(&self) -> GodotString

pub fn get_max_packet_life_time(&self) -> i64

pub fn get_max_retransmits(&self) -> i64

pub fn get_protocol(&self) -> GodotString

pub fn get_ready_state(&self) -> ChannelState

pub fn write_mode(&self) -> WriteMode

pub fn is_negotiated(&self) -> bool

pub fn is_ordered(&self) -> bool

pub fn poll(&self) -> Result<(), GodotError>

pub fn set_write_mode(&self, write_mode: i64)

pub fn was_string_packet(&self) -> bool

Trait Implementations

impl Debug for WebRTCDataChannelGDNative

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

Formats the value using the given formatter.

impl Deref for WebRTCDataChannelGDNative

type Target = WebRTCDataChannel

The resulting type after dereferencing.

fn deref(&self) -> &WebRTCDataChannel

Dereferences the value.

impl DerefMut for WebRTCDataChannelGDNative

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

Mutably dereferences the value.

impl GodotObject for WebRTCDataChannelGDNative

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 Instanciable for WebRTCDataChannelGDNative

fn construct() -> Ref<WebRTCDataChannelGDNative, Unique>

impl SubClass<Object> for WebRTCDataChannelGDNative

impl SubClass<PacketPeer> for WebRTCDataChannelGDNative

impl SubClass<Reference> for WebRTCDataChannelGDNative

impl SubClass<WebRTCDataChannel> for WebRTCDataChannelGDNative