http

Documentation

Overview

Package http provides low-level methods to interact with the Horizon instance through its REST API.

Index

• type Client
  • func (c *Client) BaseUrl() url.URL
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) Get(path string) (response *HorizonResponse, err error)
  • func (c *Client) Init(baseUrl url.URL, apiId string, apiKey string)
  • func (c *Client) Post(path string, body []byte) (response *HorizonResponse, err error)
  • func (c *Client) SetCaBundle(caBundle string)
  • func (c *Client) SetProxy(proxyUrl url.URL)
  • func (c *Client) SkipTLSVerify()
  • func (c *Client) Unmarshal(r *http.Response) (*HorizonResponse, error)
• type Feature
  • func (feature Feature) String() string
• type HorizonErrorResponse
  • func (e *HorizonErrorResponse) Error() string
• type HorizonResponse
  • func (r *HorizonResponse) HasContentType(mimeType string) bool
  • func (r *HorizonResponse) Json() *json.Decoder
• type NotImplementedError
  • func (e *NotImplementedError) Error() string

Types

type Client

type Client struct {
	Transport http.Transport
	// contains filtered or unexported fields
}

func (*Client) BaseUrl

func (c *Client) BaseUrl() url.URL

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) Get

func (c *Client) Get(path string) (response *HorizonResponse, err error)

func (*Client) Init

func (c *Client) Init(baseUrl url.URL, apiId string, apiKey string)

Init initializes the instance parameters such as its location, and authentication data.

func (*Client) Post

func (c *Client) Post(path string, body []byte) (response *HorizonResponse, err error)

func (*Client) SetCaBundle

func (c *Client) SetCaBundle(caBundle string)

SetCaBundle sets the client certificate than can be used for authentication.

func (*Client) SetProxy

func (c *Client) SetProxy(proxyUrl url.URL)

func (*Client) SkipTLSVerify

func (c *Client) SkipTLSVerify()

func (*Client) Unmarshal

func (c *Client) Unmarshal(r *http.Response) (*HorizonResponse, error)

type Feature

type Feature int

const (
	TrustchainDecoding Feature = iota
)

func (Feature) String

func (feature Feature) String() string

type HorizonErrorResponse

type HorizonErrorResponse struct {
	Code    string `json:"error"`
	Message string `json:"message"`
	Detail  string `json:"detail"`
}

func (*HorizonErrorResponse) Error

func (e *HorizonErrorResponse) Error() string

type HorizonResponse

type HorizonResponse struct {
	BaseResponse *http.Response
}

func (*HorizonResponse) HasContentType

func (r *HorizonResponse) HasContentType(mimeType string) bool

func (*HorizonResponse) Json

func (r *HorizonResponse) Json() *json.Decoder

type NotImplementedError

type NotImplementedError struct {
	Feature       Feature `json:"feature"`
	ImplementedIn string  `json:"implementedIn"`
}

func (*NotImplementedError) Error

func (e *NotImplementedError) Error() string