Crate bevy_http_client

bevy_http_client

A simple HTTP client Bevy Plugin for both native and WASM.

Example

use bevy::{prelude::*, time::common_conditions::on_timer};
use bevy_http_client::prelude::*;
use serde::Deserialize;

#[derive(Debug, Clone, Deserialize, Default)]
pub struct IpInfo {
    pub ip: String,
}

fn main() {
    let mut app = App::new();
    app.add_plugins((MinimalPlugins, HttpClientPlugin))
        .add_systems(Update, (handle_response, handle_error))
        .add_systems(
            Update,
            send_request.run_if(on_timer(std::time::Duration::from_secs(1))),
        );
    app.register_request_type::<IpInfo>();
    app.run();
}

fn send_request(mut ev_request: EventWriter<TypedRequest<IpInfo>>) {
    if let Ok(request) = HttpClient::new()
        .get("https://api.ipify.org?format=json")
        .try_with_type::<IpInfo>()
    {
        ev_request.send(request);
    }
}

/// consume TypedResponse<IpInfo> events
fn handle_response(mut events: ResMut<Events<TypedResponse<IpInfo>>>) {
    for response in events.drain() {
        let response: IpInfo = response.into_inner();
        println!("ip info: {:?}", response);
    }
}

fn handle_error(mut ev_error: EventReader<TypedResponseError<IpInfo>>) {
    for error in ev_error.read() {
        println!("Error retrieving IP: {}", error.err);
    }
}

Supported Versions

bevy	bevy_http_client
0.16	0.8.3
0.15	0.7
0.14	0.6
0.13	0.4, 0,5
0.12	0.3
0.11	0.1

License

Dual-licensed under either:

• MIT: http://opensource.org/licenses/MIT
• Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0

At your option. This means that when using this crate in your game, you may choose which license to use.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.

Modules

prelude

Structs

HttpClient

builder for ehttp request

HttpClientPlugin

Plugin that provides support for send http request and handle response.

HttpClientSetting

The setting of http client. can set the max concurrent request.

HttpRequest

HttpResponse

wrap for ehttp response

HttpResponseError

wrap for ehttp error

RequestTask

task for ehttp response result

Enums

HttpClientBuilderError

HTTP client builder error type

JsonFallback

JSON serialization fallback strategy when serialization fails

JsonSerializationError

JSON serialization error type