aboutsummaryrefslogtreecommitdiff
path: root/okio/src/commonMain/kotlin/okio/ForwardingSource.kt
blob: 0b3e9f6aa70c1b74ef0b90856eb490200de8cf0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/*
 * Copyright (C) 2014 Square, Inc.
 *
 * 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 okio

/** A [Source] which forwards calls to another. Useful for subclassing. */
expect abstract class ForwardingSource constructor(
  /** [Source] to which this instance is delegating. */
  delegate: Source,
) : Source {
  /** [Source] to which this instance is delegating. */
  val delegate: Source

  // TODO 'Source by delegate' once https://youtrack.jetbrains.com/issue/KT-23935 is fixed.

  @Throws(IOException::class)
  override fun read(sink: Buffer, byteCount: Long): Long

  override fun timeout(): Timeout

  @Throws(IOException::class)
  override fun close()

  override fun toString(): String
}