Struct QuickchartClient 

pub struct QuickchartClient { /* private fields */ }

Client for interacting with the QuickChart.io API.

This client provides a builder-pattern API for configuring and generating charts. Use new() to create a new client instance, then chain builder methods to configure your chart before calling one of the generation methods.

Example

use quickchart_rs::QuickchartClient;

let client = QuickchartClient::new()
    .chart(r#"{"type":"bar","data":{"labels":["A","B"],"datasets":[{"data":[1,2]}]}}"#.to_string())
    .width(800)
    .height(400);

let url = client.get_url().unwrap();
assert!(url.starts_with("https://quickchart.io/chart"));

Implementations

impl QuickchartClient

pub fn new() -> Self

Create a new QuickChart client instance.

pub fn chart(self, chart: String) -> Self

Set the Chart.js configuration as a JSON string. Both valid JSON and JavaScript object notation are supported.

pub fn width(self, width: usize) -> Self

pub fn height(self, height: usize) -> Self

pub fn device_pixel_ratio(self, dpr: f32) -> Self

pub fn background_color(self, color: String) -> Self

Set the background color. Supports named colors (“transparent”, “white”), HEX (“#ffffff”), RGB (“rgb(255, 0, 0)”), and HSL (“hsl(0, 100%, 50%)”) formats.

pub fn version(self, version: String) -> Self

pub fn format(self, format: String) -> Self

pub fn get_url(&self) -> Result<String, QCError>

Generate a chart URL with all configured parameters as query parameters.

Example

use quickchart_rs::QuickchartClient;

let client = QuickchartClient::new()
    .chart(r#"{"type":"bar","data":{"labels":["A","B"],"datasets":[{"data":[1,2]}]}}"#.to_string())
    .width(800)
    .height(400);

let url = client.get_url().unwrap();
assert!(url.starts_with("https://quickchart.io/chart"));
assert!(url.contains("w=800"));
assert!(url.contains("h=400"));

pub async fn get_short_url(&self) -> Result<String, QCError>

Create a short URL for the chart via POST request to /chart/create.

Example

use quickchart_rs::QuickchartClient;

let client = QuickchartClient::new()
    .chart(r#"{"type":"bar","data":{"labels":["A","B"],"datasets":[{"data":[1,2]}]}}"#.to_string())
    .get_short_url().await?;

pub async fn post(&self) -> Result<Vec<u8>, QCError>

Download the chart image as bytes via POST request.

Example

let client = QuickchartClient::new()
    .chart(r#"{"type":"bar","data":{"labels":["A","B"],"datasets":[{"data":[1,2]}]}}"#.to_string())
    .post().await?;

pub async fn to_file(&self, path: impl AsRef<Path>) -> Result<(), QCError>

Download the chart image and save it directly to a file. Convenience method that combines post() and file writing.

Example

let client = QuickchartClient::new()
    .chart(r#"{"type":"bar","data":{"labels":["A","B"],"datasets":[{"data":[1,2]}]}}"#.to_string())
    .to_file("output.png")
    .await?;

Trait Implementations

impl Default for QuickchartClient

fn default() -> Self

Returns the “default value” for a type.