requests.base

  • Auth

    Declaration

    interface Auth;

    Interface to provide user info and http headers requred for server auth.

    • authHeaders

      Declaration

      abstract string[string] authHeaders(string domain);

      Create headers for authentication

    • userName

      Declaration

      abstract string userName();

      Returns user name

    • password

      Declaration

      abstract string password();

      Returns user password

  • BasicAuthentication

    Declaration

    class BasicAuthentication: requests.base.Auth;

    Basic authentication. Adds Authorization: Basic header to request

    Example:

    1. import requests; void main() { rq = Request(); rq.authenticator = new BasicAuthentication("user", "passwd"); rs = rq.get("http://httpbin.org/basic-auth/user/passwd"); }

    • this

      Declaration

      this(string username, string password, string[] domains = []);

      Constructor.

      Parameters

      string username

      username

      string password

      password

      string[] domains

      not used now

    • authHeaders

      Declaration

      string[string] authHeaders(string domain);

      create Basic Auth header

    • userName

      Declaration

      string userName();

      returns username

    • password

      Declaration

      string password();

      return user password

  • PostFile

    Declaration

    struct PostFile;

    Struct to send multiple files in POST request.

    • fileName

      Declaration

      string fileName;

      Path to the file to send.

    • fieldName

      Declaration

      string fieldName;

      Name of the field (if empty - send file base name)

    • contentType

      Declaration

      string contentType;

      contentType of the file if not empty

  • FiniteReadable

    Declaration

    interface FiniteReadable;

    This is File-like interface for sending data to multipart forms

    • getSize

      Declaration

      abstract ulong getSize();

      size of the content

    • read

      Declaration

      abstract ubyte[] read();

      file-like read()

  • formData

    Declaration

    auto formData(string name, File f, string[string] parameters = null);

    Helper to create form elements from File.

    Parameters

    string name

    name of the field in form

    File f

    opened std.stio.File to send to server

    string[string] parameters

    optional parameters (most important are "filename" and "Content-Type")

  • formData

    Declaration

    auto formData(string name, ubyte[] b, string[string] parameters = null);

    Helper to create form elements from ubyte[].

    Parameters

    string name

    name of the field in form

    ubyte[] b

    data to send to server

    string[string] parameters

    optional parameters (can be "filename" and "Content-Type")

  • FormDataBytes

    Declaration

    class FormDataBytes: requests.base.FiniteReadable;

    Class to provide FiniteReadable from user-provided ubyte[]

    • this

      Declaration

      this(ubyte[] data);

      constructor from ubyte[]

  • FormDataFile

    Declaration

    class FormDataFile: requests.base.FiniteReadable;

    Class to provide FiniteReadable from File

    • this

      Declaration

      this(File file);

      constructor from File object

  • MultipartForm

    Declaration

    struct MultipartForm;

    This struct used to bulld POST's to forms. Each part have name and data. data is something that can be read-ed and have size. For example this can be string-like object (wrapped for reading) or opened File.

  • RequestException

    Declaration

    class RequestException: object.Exception;

    General type exception from Request

  • ReceiveAsRange

    Declaration

    struct ReceiveAsRange;

    ReceiveAsRange is InputRange used to supply client with data from response. Each popFront fetch next data portion.

    • read

      Declaration

      package ubyte[] delegate() read;

      HTTP or FTP module set up delegate read() for reading next portion of data.

  • Response

    Declaration

    class Response;

    Response

    • _code

      Declaration

      package ushort _code;

      Server status code

    • _responseBody

      Declaration

      package Buffer!ubyte _responseBody;

      Response body

    • _responseHeaders

      Declaration

      package string[string] _responseHeaders;

      Response headers

    • _uri

      Declaration

      package URI _uri;

      Initial URI

    • _finalURI

      Declaration

      package URI _finalURI;

      Final URI. Can differ from uri() if request go through redirections.

    • _receiveAsRange

      Declaration

      package ReceiveAsRange _receiveAsRange;

      stream range stored here

    • _contentReceived

      Declaration

      package long _contentReceived;

      Length of received content

    • _contentLength

      Declaration

      package long _contentLength;

      Server-supplied content length (can be -1 when unknown)

    • toString

      Declaration

      const string toString();

      string representation of response

    • format

      Declaration

      const string format(string fmt);

      format response to string (hpPqsBTUS).

      Discussion

      %h - remote hostname

      %p - remote port

      %P - remote path

      %q - query parameters

      %s - string representation

      %B - received bytes

      %T - resquest total time

      %U - request uri()

      %S - status code