dom/streams/ReadableStreamBYOBReader.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_ReadableStreamBYOBReader_h
   8 #define mozilla_dom_ReadableStreamBYOBReader_h
   9
  10 #include "js/TypeDecls.h"
  11 #include "mozilla/Attributes.h"
  12 #include "mozilla/ErrorResult.h"
  13 #include "mozilla/dom/BindingDeclarations.h"
  14 #include "mozilla/dom/ReadableStreamGenericReader.h"
  15 #include "mozilla/dom/TypedArray.h"
  16 #include "nsCycleCollectionParticipant.h"
  17 #include "nsWrapperCache.h"
  18 #include "mozilla/LinkedList.h"
  19
  20 namespace mozilla::dom {
  21
  22 class Promise;
  23 struct ReadIntoRequest;
  24 class ReadableStream;
  25
  26 }  // namespace mozilla::dom
  27
  28 namespace mozilla::dom {
  29
  30 class ReadableStreamBYOBReader final : public ReadableStreamGenericReader,
  31                                        public nsWrapperCache {
  32  public:
  33   NS_DECL_ISUPPORTS_INHERITED
  34   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS_INHERITED(
  35       ReadableStreamBYOBReader, ReadableStreamGenericReader)
  36
  37  public:
  38   explicit ReadableStreamBYOBReader(nsISupports* aGlobal);
  39
  40   bool IsDefault() override { return false; };
  41   bool IsBYOB() override { return true; }
  42   ReadableStreamDefaultReader* AsDefault() override {
  43     MOZ_CRASH("Should have verified IsDefault first");
  44     return nullptr;
  45   }
  46   ReadableStreamBYOBReader* AsBYOB() override { return this; }
  47
  48   JSObject* WrapObject(JSContext* aCx,
  49                        JS::Handle<JSObject*> aGivenProto) override;
  50
  51   static already_AddRefed<ReadableStreamBYOBReader> Constructor(
  52       const GlobalObject& global, ReadableStream& stream, ErrorResult& rv);
  53
  54   MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> Read(
  55       const ArrayBufferView& aArray, ErrorResult& rv);
  56
  57   void ReleaseLock(ErrorResult& rv);
  58
  59   LinkedList<RefPtr<ReadIntoRequest>>& ReadIntoRequests() {
  60     return mReadIntoRequests;
  61   }
  62
  63  private:
  64   ~ReadableStreamBYOBReader() override = default;
  65
  66   LinkedList<RefPtr<ReadIntoRequest>> mReadIntoRequests;
  67 };
  68
  69 namespace streams_abstract {
  70
  71 already_AddRefed<ReadableStreamBYOBReader> AcquireReadableStreamBYOBReader(
  72     ReadableStream* aStream, ErrorResult& aRv);
  73
  74 MOZ_CAN_RUN_SCRIPT void ReadableStreamBYOBReaderRead(
  75     JSContext* aCx, ReadableStreamBYOBReader* aReader,
  76     JS::Handle<JSObject*> aView, ReadIntoRequest* aReadIntoRequest,
  77     ErrorResult& aRv);
  78
  79 void ReadableStreamBYOBReaderErrorReadIntoRequests(
  80     JSContext* aCx, ReadableStreamBYOBReader* aReader,
  81     JS::Handle<JS::Value> aError, ErrorResult& aRv);
  82
  83 void ReadableStreamBYOBReaderRelease(JSContext* aCx,
  84                                      ReadableStreamBYOBReader* aReader,
  85                                      ErrorResult& aRv);
  86
  87 }  // namespace streams_abstract
  88
  89 }  // namespace mozilla::dom
  90
  91 #endif  // mozilla_dom_ReadableStreamBYOBReader_h