hphp/hack/hhi/traits.hhi

   1 <?hh
   2 /**
   3  * Copyright (c) 2014, Facebook, Inc.
   4  * All rights reserved.
   5  *
   6  * This source code is licensed under the MIT license found in the
   7  * LICENSE file in the "hack" directory of this source tree.
   8  *
   9  */
  10
  11 /**
  12  * This file provides type information for some of PHP's predefined interfaces
  13  *
  14  * YOU SHOULD NEVER INCLUDE THIS FILE ANYWHERE!!!
  15  */
  16
  17 trait StrictIterable<+Tv> implements Iterable<Tv> {
  18
  19   /* HH_IGNORE_ERROR[2082] T30260145 */
  20   public function toArray(): array;
  21
  22   public function toValuesArray(): varray<Tv>;
  23
  24   /* HH_FIXME[4120]: While this violates our variance annotations, we are
  25    * returning a copy of the underlying collection, so it is actually safe
  26    * See #6853603. */
  27   public function toVector(): Vector<Tv>;
  28
  29   public function toImmVector(): ImmVector<Tv>;
  30
  31   /* HH_FIXME[4120]: While this violates our variance annotations, we are
  32    * returning a copy of the underlying collection, so it is actually safe
  33    * See #6853603. */
  34
  35   public function toSet(): Set<Tv> where Tv as arraykey;
  36
  37   public function toImmSet(): ImmSet<Tv> where Tv as arraykey;
  38
  39   public function lazy(): Iterable<Tv>;
  40
  41   public function values(): Iterable<Tv>;
  42
  43   public function map<Tu>((function(Tv): Tu) $callback): Iterable<Tu>;
  44
  45   public function filter((function(Tv): bool) $callback): Iterable<Tv>;
  46
  47   public function zip<Tu>(Traversable<Tu> $traversable): Iterable<Pair<Tv,Tu>>;
  48
  49   public function take(int $n): Iterable<Tv>;
  50
  51   public function takeWhile((function(Tv): bool) $n): Iterable<Tv>;
  52
  53   public function skip(int $n): Iterable<Tv>;
  54
  55   public function skipWhile((function(Tv): bool) $n): Iterable<Tv>;
  56
  57   public function slice(int $start, int $len): Iterable<Tv>;
  58
  59   public function concat<Tu super Tv>(Traversable<Tu> $traversable): Iterable<Tu>;
  60
  61   public function firstValue(): ?Tv;
  62
  63   public function lastValue(): ?Tv;
  64
  65 }
  66
  67
  68 trait StrictKeyedIterable<Tk,+Tv> implements KeyedIterable<Tk,Tv> {
  69   /* HH_IGNORE_ERROR[2082] T30260145 */
  70   public function toArray(): array;
  71
  72   public function toValuesArray(): varray<Tv>;
  73
  74   public function toKeysArray(): varray<Tk>;
  75
  76   /* HH_FIXME[4120]: While this violates our variance annotations, we are
  77    * returning a copy of the underlying collection, so it is actually safe
  78    * See #6853603. */
  79   public function toVector(): Vector<Tv>;
  80
  81   public function toImmVector(): ImmVector<Tv>;
  82
  83   /* HH_FIXME[4120]: While this violates our variance annotations, we are
  84    * returning a copy of the underlying collection, so it is actually safe
  85    * See #6853603. */
  86   public function toMap(): Map<Tk, Tv> where Tk as arraykey;
  87
  88   public function toImmMap(): ImmMap<Tk, Tv> where Tk as arraykey;
  89
  90   /* HH_FIXME[4120]: While this violates our variance annotations, we are
  91    * returning a copy of the underlying collection, so it is actually safe
  92    * See #6853603. */
  93   public function toSet(): Set<Tv> where Tv as arraykey;
  94
  95   public function toImmSet(): ImmSet<Tv> where Tv as arraykey;
  96
  97   public function lazy(): KeyedIterable<Tk,Tv>;
  98
  99   public function values(): Iterable<Tv>;
 100
 101   public function keys(): Iterable<Tk>;
 102
 103   public function map<Tu>((function(Tv): Tu) $callback): KeyedIterable<Tk,Tu>;
 104
 105   public function mapWithKey<Tu>(
 106     (function(Tk,Tv): Tu) $callback
 107   ): KeyedIterable<Tk,Tu>;
 108
 109   public function filter((function(Tv): bool) $callback): KeyedIterable<Tk,Tv>;
 110
 111   public function filterWithKey(
 112     (function(Tk,Tv): bool) $callback
 113   ): KeyedIterable<Tk,Tv>;
 114
 115   public function zip<Tu>(
 116     Traversable<Tu> $traversable
 117   ): KeyedIterable<Tk,Pair<Tv,Tu>>;
 118
 119   public function take(int $n): KeyedIterable<Tk, Tv>;
 120
 121   public function takeWhile((function(Tv): bool) $n): KeyedIterable<Tk, Tv>;
 122
 123   public function skip(int $n): KeyedIterable<Tk, Tv>;
 124
 125   public function skipWhile((function(Tv): bool) $n): KeyedIterable<Tk, Tv>;
 126
 127   public function slice(int $start, int $len): KeyedIterable<Tk, Tv>;
 128
 129   public function concat<Tu super Tv>(Traversable<Tu> $traversable): Iterable<Tu>;
 130
 131   public function firstValue(): ?Tv;
 132
 133   public function firstKey(): ?Tk;
 134
 135   public function lastValue(): ?Tv;
 136
 137   public function lastKey(): ?Tk;
 138
 139 }
 140
 141
 142 trait LazyIterable<+Tv> implements Iterable<Tv> {
 143   /* HH_IGNORE_ERROR[2082] T30260145 */
 144   public function toArray(): array;
 145
 146   public function toValuesArray(): varray<Tv>;
 147
 148   /* HH_FIXME[4120]: While this violates our variance annotations, we are
 149    * returning a copy of the underlying collection, so it is actually safe
 150    * See #6853603. */
 151   public function toVector(): Vector<Tv>;
 152
 153   public function toImmVector(): ImmVector<Tv>;
 154
 155   /* HH_FIXME[4120]: While this violates our variance annotations, we are
 156    * returning a copy of the underlying collection, so it is actually safe
 157    * See #6853603. */
 158   public function toSet(): Set<Tv> where Tv as arraykey;
 159
 160   public function toImmSet(): ImmSet<Tv> where Tv as arraykey;
 161
 162   public function lazy(): Iterable<Tv>;
 163
 164   public function values(): Iterable<Tv>;
 165
 166   public function map<Tu>((function(Tv): Tu) $callback): Iterable<Tu>;
 167
 168   public function filter((function(Tv): bool) $callback): Iterable<Tv>;
 169
 170   public function zip<Tu>(Traversable<Tu> $traversable): Iterable<Pair<Tv,Tu>>;
 171
 172   public function take(int $n): Iterable<Tv>;
 173
 174   public function takeWhile((function(Tv): bool) $n): Iterable<Tv>;
 175
 176   public function skip(int $n): Iterable<Tv>;
 177
 178   public function skipWhile((function(Tv): bool) $n): Iterable<Tv>;
 179
 180   public function slice(int $start, int $len): Iterable<Tv>;
 181
 182   public function concat<Tu super Tv>(Traversable<Tu> $traversable): Iterable<Tu>;
 183
 184   public function firstValue(): ?Tv;
 185
 186   public function lastValue(): ?Tv;
 187
 188 }
 189
 190
 191 trait LazyKeyedIterable<Tk,+Tv> implements KeyedIterable<Tk,Tv> {
 192   /* HH_IGNORE_ERROR[2082] T30260145 */
 193   public function toArray(): array;
 194
 195   public function toValuesArray(): varray<Tv>;
 196
 197   public function toKeysArray(): varray<Tk>;
 198
 199   /* HH_FIXME[4120]: While this violates our variance annotations, we are
 200    * returning a copy of the underlying collection, so it is actually safe
 201    * See #6853603. */
 202   public function toVector(): Vector<Tv>;
 203
 204   public function toImmVector(): ImmVector<Tv>;
 205
 206   /* HH_FIXME[4120]: While this violates our variance annotations, we are
 207    * returning a copy of the underlying collection, so it is actually safe
 208    * See #6853603. */
 209
 210   public function toMap(): Map<Tk, Tv> where Tk as arraykey;
 211
 212   public function toImmMap(): ImmMap<Tk, Tv> where Tk as arraykey;
 213
 214   /* HH_FIXME[4120]: While this violates our variance annotations, we are
 215    * returning a copy of the underlying collection, so it is actually safe
 216    * See #6853603. */
 217
 218   public function toSet(): Set<Tv> where Tv as arraykey;
 219
 220   public function toImmSet(): ImmSet<Tv> where Tv as arraykey;
 221
 222   public function lazy(): KeyedIterable<Tk,Tv>;
 223
 224   public function values(): Iterable<Tv>;
 225
 226   public function keys(): Iterable<Tk>;
 227
 228   public function map<Tu>((function(Tv): Tu) $callback): KeyedIterable<Tk,Tu>;
 229
 230   public function mapWithKey<Tu>(
 231     (function(Tk,Tv): Tu) $callback
 232   ): KeyedIterable<Tk,Tu>;
 233
 234   public function filter((function(Tv): bool) $callback): KeyedIterable<Tk,Tv>;
 235
 236   public function filterWithKey(
 237     (function(Tk,Tv): bool) $callback
 238   ): KeyedIterable<Tk,Tv>;
 239
 240   public function zip<Tu>(
 241     Traversable<Tu> $traversable
 242   ): KeyedIterable<Tk,Pair<Tv,Tu>>;
 243
 244   public function take(int $n): KeyedIterable<Tk, Tv>;
 245
 246   public function takeWhile((function(Tv): bool) $n): KeyedIterable<Tk, Tv>;
 247
 248   public function skip(int $n): KeyedIterable<Tk, Tv>;
 249
 250   public function skipWhile((function(Tv): bool) $n): KeyedIterable<Tk, Tv>;
 251
 252   public function slice(int $start, int $len): KeyedIterable<Tk, Tv>;
 253
 254   public function concat<Tu super Tv>(Traversable<Tu> $traversable): Iterable<Tu>;
 255
 256   public function firstValue(): ?Tv;
 257
 258   public function firstKey(): ?Tk;
 259
 260   public function lastValue(): ?Tv;
 261
 262   public function lastKey(): ?Tk;
 263
 264 }