hugegraph-client-go/api/api.response.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package api

import (
    "bytes"
    "fmt"
    "io"
    "io/ioutil"
    "net/http"
    "strconv"
    "strings"
)

// Response represents the API response.
type Response struct {
    StatusCode int
    Header     http.Header
    Body       io.ReadCloser
}

// String returns the response as a string.
//
// The intended usage is for testing or debugging only.
func (r *Response) String() string {
    var (
        out = new(bytes.Buffer)
        b1  = bytes.NewBuffer([]byte{})
        b2  = bytes.NewBuffer([]byte{})
        tr  io.Reader
    )

    if r != nil && r.Body != nil {
        tr = io.TeeReader(r.Body, b1)
        defer func(Body io.ReadCloser) {
            err := Body.Close()
            if err != nil {

            }
        }(r.Body)

        if _, err := io.Copy(b2, tr); err != nil {
            out.WriteString(fmt.Sprintf("<error reading response body: %v>", err))
            return out.String()
        }
        defer func() { r.Body = ioutil.NopCloser(b1) }()
    }

    if r != nil {
        out.WriteString(fmt.Sprintf("[%d %s]", r.StatusCode, http.StatusText(r.StatusCode)))
        if r.StatusCode > 0 {
            out.WriteRune(' ')
        }
    } else {
        out.WriteString("[0 <nil>]")
    }

    if r != nil && r.Body != nil {
        out.ReadFrom(b2) // errcheck exclude (*bytes.Buffer).ReadFrom
    }

    return out.String()
}

// Status returns the response status as a string.
func (r *Response) Status() string {
    var b strings.Builder
    if r != nil {
        b.WriteString(strconv.Itoa(r.StatusCode))
        b.WriteString(" ")
        b.WriteString(http.StatusText(r.StatusCode))
    }
    return b.String()
}

// IsError returns true when the response status indicates failure.
func (r *Response) IsError() bool {
    return r.StatusCode > 299
}