summaryrefslogtreecommitdiffstats
path: root/dom/fs/api/FileSystemFileHandle.h
blob: c0606c85a6fe718d9eac47370746330e907c01f1 (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef DOM_FS_FILESYSTEMFILEHANDLE_H_
#define DOM_FS_FILESYSTEMFILEHANDLE_H_

#include "mozilla/dom/FileSystemHandle.h"

namespace mozilla {

class ErrorResult;

namespace dom {

struct FileSystemCreateWritableOptions;

class FileSystemFileHandle final : public FileSystemHandle {
 public:
  FileSystemFileHandle(nsIGlobalObject* aGlobal,
                       RefPtr<FileSystemManager>& aManager,
                       const fs::FileSystemEntryMetadata& aMetadata,
                       fs::FileSystemRequestHandler* aRequestHandler);

  FileSystemFileHandle(nsIGlobalObject* aGlobal,
                       RefPtr<FileSystemManager>& aManager,
                       const fs::FileSystemEntryMetadata& aMetadata);

  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(FileSystemFileHandle,
                                           FileSystemHandle)

  // WebIDL Boilerplate
  JSObject* WrapObject(JSContext* aCx,
                       JS::Handle<JSObject*> aGivenProto) override;

  // WebIDL interface
  FileSystemHandleKind Kind() const override;

  already_AddRefed<Promise> GetFile(ErrorResult& aError);

  already_AddRefed<Promise> CreateWritable(
      const FileSystemCreateWritableOptions& aOptions, ErrorResult& aError);

  already_AddRefed<Promise> CreateSyncAccessHandle(ErrorResult& aError);

  // [Serializable]
  static already_AddRefed<FileSystemFileHandle> ReadStructuredClone(
      JSContext* aCx, nsIGlobalObject* aGlobal,
      JSStructuredCloneReader* aReader);

 private:
  ~FileSystemFileHandle() = default;
};

}  // namespace dom
}  // namespace mozilla

#endif  // DOM_FS_FILESYSTEMFILEHANDLE_H_