Git Product home page Git Product logo

Comments (2)

algesten avatar algesten commented on July 24, 2024

This comes from that early ureq API was modelled on superagent, which is still my goto nodejs http client and somewhat of a hero for me in API design.

I think that's the wrong thing in most cases.

Is it? If we ask "what could the user possibly mean with this input?"

Philosophically both ureq (and now hreq), were and are driven by a feeling that in the rust community, sometimes correctness and strict adherence to spec overrides usability concerns in API design. The http crate is better now, but the correctness of hyper, where the http crate started, often shows in the API the user is exposed to.

A fast and correct HTTP implementation for Rust.

For example this method signature:

impl Request {
  fn header(&self, key: &str) -> Option<&str> {}
}

is no good if the overriding concern for the API is correctness. Not all correct header values can be represented as rust String, which forces the use of Result and/or an intermediary HeaderValue.

But how often do we really encounter such headers in the wild?

I want ureq (and hreq) to be correct and on spec, I want to be able to handle such headers if I find them, but without forcing the user of the API to jump through hoops. Simple, rememberable and User first API (how I encapsulated these thoughts in a design goal).

This is the bigger picture of the absence of Result, the synthetic http error, and why using a path as URL defaults to localhost.

In early ureq I did however lurch too far in the other direction, so in the same way I'm for reintroducing some Result instead of synthetic http error, also the localhost-by-default decision is up for challenge.

from ureq.

jsha avatar jsha commented on July 24, 2024

Thanks for the additional background on the API design!

I think we can probably find a middle path, where we keep the API simple and also filter out some error cases, by deferring all errors until .do_call(). We would accept any String in the constructor of Request, and do validation later. If .do_call() finds that the URL is invalid, it would return a Response with the Error field already set.

from ureq.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.