View Source z_url_fetch (zotonic_stdlib v1.23.1)

Fetch (part of) the data of an Url, including its headers.

Summary

Functions

Fetch the data and headers from an url

Fetch the data and headers from an url

Fetch the first 64 kilobytes of data and headers from an url

Fetch the first N bytes of data and headers from an url, optionally save to the file device

Fetch the first N bytes of data and headers from an url, optionally save to the file device

Types

fetch_result/0

-type fetch_result() ::
          {ok,
           {FinalUrl :: string(),
            RespHeaders :: [{string(), string()}],
            ContentLength :: non_neg_integer(),
            Content :: binary()}} |
          {error, Reason :: term()}.

option/0

-type option() ::
          {device, pid()} |
          {timeout, pos_integer()} |
          {max_length, pos_integer()} |
          {use_range, boolean()} |
          {authorization, binary() | string()} |
          {accept, binary() | string()} |
          {user_agent, binary() | string()} |
          {language, atom()} |
          {content_type, binary() | string()} |
          {headers, [{binary() | string(), binary() | string()}]} |
          insecure.

options/0

-type options() :: [option()].

Functions

ensure_profiles()

-spec ensure_profiles() -> ok.

fetch(Url, Options)

-spec fetch(Url, Options) -> fetch_result() when Url :: string() | binary(), Options :: options().

Fetch the data and headers from an url

fetch(Method, Url, Payload, Options)

-spec fetch(Method, Url, Payload, Options) -> fetch_result()
               when
                   Method :: get | post | put | delete | patch,
                   Url :: string() | binary(),
                   Payload :: binary(),
                   Options :: options().

Fetch the data and headers from an url

fetch_partial(Url)

-spec fetch_partial(Url) -> fetch_result() when Url :: string() | binary().

Fetch the first 64 kilobytes of data and headers from an url

fetch_partial(Url, Options)

-spec fetch_partial(Url, Options) -> fetch_result()
                       when Url :: string() | binary(), Options :: options().

Fetch the first N bytes of data and headers from an url, optionally save to the file device

fetch_partial(Method, Url, Payload, Options)

-spec fetch_partial(Method, Url, Payload, Options) -> fetch_result()
                       when
                           Method :: get | post | delete | put | patch,
                           Url :: string() | binary(),
                           Payload :: binary(),
                           Options :: options().

Fetch the first N bytes of data and headers from an url, optionally save to the file device

periodic_cleanup()

-spec periodic_cleanup() -> ok.

profile(Url)

-spec profile(string() | binary()) -> atom().