Struct Client 

pub struct Client<'a> { /* private fields */ }

Builder for constructing and sending a blocking HTTP request.

Defaults to GET when created via Default.

Implementations

impl<'a> Client<'a>

pub fn new() -> Self

Creates a new builder with default settings (GET, no headers, no query).

pub fn with_user_agent(agent: impl Into<Cow<'a, str>>) -> Self

Creates a new builder with a default User-Agent header.

The User-Agent is only applied if the request does not already set one.

pub fn method(self, method: Method) -> Self

Sets the HTTP method explicitly.

pub fn get(self) -> Self

Sets the request method to GET.

pub fn post(self) -> Self

Sets the request method to POST.

pub fn put(self) -> Self

Sets the request method to PUT.

pub fn delete(self) -> Self

Sets the request method to DELETE.

pub fn head(self) -> Self

Sets the request method to HEAD.

pub fn options(self) -> Self

Sets the request method to OPTIONS.

pub fn patch(self) -> Self

Sets the request method to PATCH.

pub fn connect(self) -> Self

Sets the request method to CONNECT.

pub fn trace(self) -> Self

Sets the request method to TRACE.

pub fn header(self, header: Header<'a>) -> Self

Adds a single header.

Examples

let resp = curl_rest::Client::default()
    .get()
    .header(curl_rest::Header::Authorization("Bearer token".into()))
    .send("https://example.com/private")?;

Errors

This method does not return errors. Header validation happens in send.

pub fn headers<I>(self, headers: I) -> Self

where I: IntoIterator<Item = Header<'a>>,

Adds multiple headers.

Examples

let resp = curl_rest::Client::default()
    .get()
    .headers([
        curl_rest::Header::Accept("application/json".into()),
        curl_rest::Header::UserAgent("curl-rest/0.1".into()),
    ])
    .send("https://example.com/users")?;

Errors

This method does not return errors. Header validation happens in send.

pub fn query_param(self, param: QueryParam<'a>) -> Self

Adds a single query parameter.

Examples

let resp = curl_rest::Client::default()
    .get()
    .query_param(curl_rest::QueryParam::new("q", "rust"))
    .send("https://example.com/search")?;

Errors

This method does not return errors. URL validation happens in send.

pub fn query_param_kv( self, key: impl Into<Cow<'a, str>>, value: impl Into<Cow<'a, str>>, ) -> Self

Adds a single query parameter by key/value.

Examples

let resp = curl_rest::Client::default()
    .get()
    .query_param_kv("page", "1")
    .send("https://example.com/search")?;

Errors

This method does not return errors. URL validation happens in send.

pub fn query_params<I>(self, params: I) -> Self

where I: IntoIterator<Item = QueryParam<'a>>,

Adds multiple query parameters.

Examples

let resp = curl_rest::Client::default()
    .get()
    .query_params([
        curl_rest::QueryParam::new("sort", "desc"),
        curl_rest::QueryParam::new("limit", "50"),
    ])
    .send("https://example.com/items")?;

Errors

This method does not return errors. URL validation happens in send.

pub fn body(self, body: Body<'a>) -> Self

Sets a request body explicitly.

Examples

let resp = curl_rest::Client::default()
    .post()
    .body(curl_rest::Body::Text("hello".into()))
    .send("https://example.com/echo")?;

Errors

This method does not return errors. Failures are reported by send.

pub fn body_bytes(self, bytes: impl Into<Cow<'a, [u8]>>) -> Self

Sets a raw byte body.

Examples

let resp = curl_rest::Client::default()
    .post()
    .body_bytes(vec![1, 2, 3])
    .send("https://example.com/bytes")?;

Errors

This method does not return errors. Failures are reported by send.

pub fn body_text(self, text: impl Into<Cow<'a, str>>) -> Self

Sets a text body with a text/plain; charset=utf-8 default content type.

Examples

let resp = curl_rest::Client::default()
    .post()
    .body_text("hello")
    .send("https://example.com/echo")?;

Errors

This method does not return errors. Failures are reported by send.

pub fn body_json(self, json: impl Into<Cow<'a, str>>) -> Self

Sets a JSON body with an application/json default content type.

Examples

let resp = curl_rest::Client::default()
    .post()
    .body_json(r#"{"name":"stanley"}"#)
    .send("https://example.com/users")?;

Errors

This method does not return errors. Failures are reported by send.

pub fn send(self, url: &str) -> Result<Response, Error>

Sends the request to the provided URL.

Errors

Returns an error if the URL is invalid, a header name or value is malformed, the status code is unrecognized, or libcurl reports a failure.

Trait Implementations

impl<'a> Default for Client<'a>

fn default() -> Self

Returns the “default value” for a type.