gigahorse.StreamResponse.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gigahorse-core_2.13 Show documentation

Gigahorse is an HTTP client for Scala with multiple backend support.

The newest version!

/*
 * Copyright 2016 by Eugene Yokota
 *
 * Licensed 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 gigahorse

import java.nio.ByteBuffer

/** Represents a stream response.
 */
abstract class StreamResponse {
  /**
   * Return the current headers of the request being constructed
   */
  def allHeaders: Map[String, List[String]]

  /**
   * The response body as Reactive Stream of ByteBuffers.
   */
  def byteBuffers: Stream[ByteBuffer]

  /**
   * The response body as Reactive Stream of Newline delimited strings.
   */
  def newLineDelimited: Stream[String]

  /**
   * The response status code.
   */
  def status: Int

  /**
   * The response status message.
   */
  def statusText: String

  /**
   * Get a response header.
   */
  def header(key: String): Option[String]
}