Struct gdnative_bindings::HTTPClient

source ·

pub struct HTTPClient { /* private fields */ }

Expand description

core class HTTPClient inherits Reference (reference-counted).

This class has related types in the http_client module.

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

The lifetime of this object is automatically managed through reference counting.

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 Ownership in these types tracks whether ownership is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations§

source §

impl HTTPClient

Constants

source

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

Creates a new instance of this object.

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

source

pub fn close(&self)

Closes the current connection, allowing reuse of this HTTPClient.

source

pub fn connect_to_host(
 &self,
 host: impl Into<GodotString>,
 port: i64,
 use_ssl: bool,
 verify_host: bool
) -> GodotResult

Connects to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. If no port is specified (or -1 is used), it is automatically set to 80 for HTTP and 443 for HTTPS (if use_ssl is enabled). verify_host will check the SSL identity of the host if set to true.

Default Arguments

port - -1
use_ssl - false
verify_host - true

source

pub fn connection(&self) -> Option<Ref<StreamPeer, Shared>>

The connection to use for this client.

source

pub fn read_chunk_size(&self) -> i64

The size of the buffer used and maximum bytes to read per iteration. See read_response_body_chunk.

source

pub fn get_response_body_length(&self) -> i64

Returns the response’s body length. Note: Some Web servers may not send a body length. In this case, the value returned will be -1. If using chunked transfer encoding, the body length will also be -1.

source

pub fn get_response_code(&self) -> i64

Returns the response’s HTTP status code.

source

pub fn get_response_headers(&self) -> PoolArray<GodotString>

Returns the response headers.

source

pub fn get_response_headers_as_dictionary(&self) -> Dictionary

Sample code is GDScript unless otherwise noted.

Returns all response headers as a Dictionary of structure { "key": "value1; value2" } where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where “; “ is used as separator. Example:

{
    "content-length": 12,
    "Content-Type": "application/json; charset=UTF-8",
}

source

pub fn get_status(&self) -> Status

Returns a Status constant. Need to call poll in order to get status updates.

source

pub fn has_response(&self) -> bool

If true, this HTTPClient has a response available.

source

pub fn is_blocking_mode_enabled(&self) -> bool

If true, execution will block until all data is read from the response.

source

pub fn is_response_chunked(&self) -> bool

If true, this HTTPClient has a response that is chunked.

source

pub fn poll(&self) -> GodotResult

This needs to be called in order to have any request processed. Check results with get_status.

source

pub fn query_string_from_dict(&self, fields: Dictionary) -> GodotString

Sample code is GDScript unless otherwise noted.

Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.:

var fields = {"username": "user", "password": "pass"}
var query_string = http_client.query_string_from_dict(fields)
# Returns "username=user&password=pass"

Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added.

var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]}
var query_string = http_client.query_string_from_dict(fields)
# Returns "single=123&not_valued&multiple=22&multiple=33&multiple=44"

source

pub fn read_response_body_chunk(&self) -> PoolArray<u8>

Reads one chunk from the response.

source

pub fn request(
 &self,
 method: i64,
 url: impl Into<GodotString>,
 headers: PoolArray<GodotString>,
 body: impl Into<GodotString>
) -> GodotResult

Sample code is GDScript unless otherwise noted.

Sends a request to the connected host. The URL parameter is usually just the part after the host, so for http://somehost.com/index.php, it is /index.php. When sending requests to an HTTP proxy server, it should be an absolute URL. For HTTPClient.METHOD_OPTIONS requests, * is also allowed. For HTTPClient.METHOD_CONNECT requests, it should be the authority component (host:port). Headers are HTTP request headers. For available HTTP methods, see Method. To create a POST request with query strings to push to the server, do:

var fields = {"username" : "user", "password" : "pass"}
var query_string = http_client.query_string_from_dict(fields)
var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())]
var result = http_client.request(http_client.METHOD_POST, "/index.php", headers, query_string)

Note: The request_data parameter is ignored if method is HTTPClient.METHOD_GET. This is because GET methods can’t contain request data. As a workaround, you can pass request data as a query string in the URL. See String.http_escape for an example.

Default Arguments

body - ""

source

pub fn request_raw(
 &self,
 method: i64,
 url: impl Into<GodotString>,
 headers: PoolArray<GodotString>,
 body: PoolArray<u8>
) -> GodotResult

Sends a raw request to the connected host. The URL parameter is usually just the part after the host, so for http://somehost.com/index.php, it is /index.php. When sending requests to an HTTP proxy server, it should be an absolute URL. For HTTPClient.METHOD_OPTIONS requests, * is also allowed. For HTTPClient.METHOD_CONNECT requests, it should be the authority component (host:port). Headers are HTTP request headers. For available HTTP methods, see Method. Sends the body data raw, as a byte array and does not encode it in any way.

source

pub fn set_blocking_mode(&self, enabled: bool)

If true, execution will block until all data is read from the response.

source

pub fn set_connection(&self, connection: impl AsArg<StreamPeer>)

The connection to use for this client.

source

pub fn set_http_proxy(&self, host: impl Into<GodotString>, port: i64)

Sets the proxy server for HTTP requests. The proxy server is unset if host is empty or port is -1.

source

pub fn set_https_proxy(&self, host: impl Into<GodotString>, port: i64)

Sets the proxy server for HTTPS requests. The proxy server is unset if host is empty or port is -1.

source

pub fn set_read_chunk_size(&self, bytes: i64)

The size of the buffer used and maximum bytes to read per iteration. See read_response_body_chunk.

Methods from Deref<Target = Object>§

source

pub const NOTIFICATION_POSTINITIALIZE: i64 = 0i64

source

pub const CONNECT_DEFERRED: i64 = 1i64

source

pub const NOTIFICATION_PREDELETE: i64 = 1i64

source

pub const CONNECT_PERSIST: i64 = 2i64

source

pub const CONNECT_ONESHOT: i64 = 4i64

source

pub const CONNECT_REFERENCE_COUNTED: i64 = 8i64

source

pub fn add_user_signal(
 &self,
 signal: impl Into<GodotString>,
 arguments: VariantArray
)

Adds a user-defined signal. Arguments are optional, but can be added as an Array of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments

arguments - [ ]

source

pub unsafe fn call(
 &self,
 method: impl Into<GodotString>,
 varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

pub unsafe fn call_deferred(
 &self,
 method: impl Into<GodotString>,
 varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

pub unsafe fn callv(
 &self,
 method: impl Into<GodotString>,
 arg_array: VariantArray
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to call, this method does not support a variable number of arguments but expects all parameters to be via a single Array.

callv("set", [ "position", Vector2(42.0, 0.0) ])

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

source

pub fn can_translate_messages(&self) -> bool

Returns true if the object can translate strings. See set_message_translation and tr.

source

pub fn connect(
 &self,
 signal: impl Into<GodotString>,
 target: impl AsArg<Object>,
 method: impl Into<GodotString>,
 binds: VariantArray,
 flags: i64
) -> GodotResult

Sample code is GDScript unless otherwise noted.

Connects a signal to a method on a target object. Pass optional binds to the call as an Array of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal. Use flags to set deferred or one-shot connections. See ConnectFlags constants. A signal can only be connected once to a method. It will print an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED. To avoid this, first, use is_connected to check for existing connections. If the target is destroyed in the game’s lifecycle, the connection will be lost. Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to connect and parameters used when calling emit_signal:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Default Arguments

binds - [ ]
flags - 0

source

pub fn disconnect(
 &self,
 signal: impl Into<GodotString>,
 target: impl AsArg<Object>,
 method: impl Into<GodotString>
)

Disconnects a signal from a method on the given target. If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected to ensure that the connection exists.

source

pub fn emit_signal(
 &self,
 signal: impl Into<GodotString>,
 varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

source

pub fn get(&self, property: impl Into<GodotString>) -> Variant

Returns the Variant value of the given property. If the property doesn’t exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

source

pub fn get_class(&self) -> GodotString

Returns the object’s class as a String. See also is_class. Note: get_class does not take class_name declarations into account. If the object has a class_name defined, the base class name will be returned instead.

source

pub fn get_incoming_connections(&self) -> VariantArray

Returns an Array of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

source is a reference to the signal emitter.
signal_name is the name of the connected signal.
method_name is the name of the method to which the signal is connected.

source

pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant

Gets the object’s property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode". Note: Even though the method takes NodePath argument, it doesn’t support actual paths to Nodes in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource instead.

source

pub fn get_instance_id(&self) -> i64

Returns the object’s unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

source

pub fn get_meta(
 &self,
 name: impl Into<GodotString>,
 default: impl OwnedToVariant
) -> Variant

Returns the object’s metadata entry for the given name. Throws error if the entry does not exist, unless default is not null (in which case the default value will be returned).

Default Arguments

default - null

source

pub fn get_meta_list(&self) -> PoolArray<GodotString>

Returns the object’s metadata as a PoolStringArray.

source

pub fn get_method_list(&self) -> VariantArray

Returns the object’s methods and their signatures as an Array.

source

pub fn get_property_list(&self) -> VariantArray

Returns the object’s property list as an Array of dictionaries. Each property’s Dictionary contain at least name: String and type: int (see [enum Variant.Type]) entries. Optionally, it can also include hint: int (see [PropertyHint][PropertyHint]), hint_string: String, and usage: int (see [PropertyUsageFlags][PropertyUsageFlags]).

source

pub fn get_script(&self) -> Option<Ref<Reference, Shared>>

Returns the object’s Script instance, or null if none is assigned.

source

pub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray

Returns an Array of connections for the given signal.

source

pub fn get_signal_list(&self) -> VariantArray

Returns the list of signals as an Array of dictionaries.

source

pub fn has_meta(&self, name: impl Into<GodotString>) -> bool

Returns true if a metadata entry is found with the given name.

source

pub fn has_method(&self, method: impl Into<GodotString>) -> bool

Returns true if the object contains the given method.

source

pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool

Returns true if the given signal exists.

source

pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool

Returns true if the given user-defined signal exists. Only signals added using add_user_signal are taken into account.

source

pub fn is_blocking_signals(&self) -> bool

Returns true if signal emission blocking is enabled.

source

pub fn is_class(&self, class: impl Into<GodotString>) -> bool

Returns true if the object inherits from the given class. See also get_class. Note: is_class does not take class_name declarations into account. If the object has a class_name defined, is_class will return false for that name.

source

pub fn is_connected(
 &self,
 signal: impl Into<GodotString>,
 target: impl AsArg<Object>,
 method: impl Into<GodotString>
) -> bool

Returns true if a connection exists for a given signal, target, and method.

source

pub fn is_queued_for_deletion(&self) -> bool

Returns true if the Node.queue_free method was called for the object.

source

pub fn notification(&self, what: i64, reversed: bool)

Send a given notification to the object, which will also trigger a call to the [_notification][Self::_notification] method of all classes that the object inherits from. If reversed is true, [_notification][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed is false, [_notification][Self::_notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments

reversed - false

source

pub fn property_list_changed_notify(&self)

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

source

pub fn remove_meta(&self, name: impl Into<GodotString>)

Removes a given entry from the object’s metadata. See also set_meta.

source

pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

Assigns a new value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing will happen. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

source

pub fn set_block_signals(&self, enable: bool)

If set to true, signal emission is blocked.

source

pub fn set_deferred(
 &self,
 property: impl Into<GodotString>,
 value: impl OwnedToVariant
)

Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set via call_deferred, i.e. call_deferred("set", property, value). Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

source

pub fn set_indexed(
 &self,
 property: impl Into<NodePath>,
 value: impl OwnedToVariant
)

Sample code is GDScript unless otherwise noted.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

source

pub fn set_message_translation(&self, enable: bool)

Defines whether the object can translate strings (with calls to tr). Enabled by default.

source

pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)

Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant value. To remove a given entry from the object’s metadata, use remove_meta. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

source

pub fn set_script(&self, script: impl AsArg<Reference>)

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init][Self::_init] method will be called.

source

pub fn to_string(&self) -> GodotString

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [_to_string][Self::_to_string] to customize the String representation.

source

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See set_message_translation.

Trait Implementations§

source §

impl Debug for HTTPClient

source §

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

Formats the value using the given formatter. Read more

source §

impl Deref for HTTPClient

§

type Target = Reference

The resulting type after dereferencing.

source §

fn deref(&self) -> &Reference

Dereferences the value.

source §

impl DerefMut for HTTPClient

source §

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

Mutably dereferences the value.

source §

impl GodotObject for HTTPClient

§

type Memory = 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.

source §

fn class_name() -> &'static str

source §

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.

source §

fn new() -> Ref<Self, Unique>where
Self: Instanciable,

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

source §

fn cast<T>(&self) -> Option<&T>where
T: GodotObject + SubClass<Self>,

Performs a dynamic reference downcast to target type. Read more

source §

fn upcast<T>(&self) -> &Twhere
T: GodotObject,
Self: SubClass<T>,

Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more

source §

unsafe fn assume_shared(&self) -> Ref<Self, Shared>where
Self: Sized,

Creates a persistent reference to the same Godot object with shared thread access. Read more

source §

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal>where
Self: Sized + GodotObject<Memory = RefCounted>,

Creates a persistent reference to the same Godot object with thread-local thread access. Read more

source §

unsafe fn assume_unique(&self) -> Ref<Self, Unique>where
Self: Sized,

Creates a persistent reference to the same Godot object with unique access. Read more

source §

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id. Read more

source §

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use. Read more

source §