XmtpElixirSdk.BrowserShim.Opfs (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Request builders for browser-managed storage operations.

Use these helpers when your browser runtime is responsible for OPFS access and you want Elixir and the browser to agree on one stable request format.

This module only builds request envelopes. It does not perform file I/O by itself.

Summary

Types

t()

Functions

clear_all_request()

Build a request to clear all OPFS-managed SDK files.

delete_file_request(path)

Build a request to delete a file from OPFS.

export_db_request(path)

Build a request to export a database file from OPFS.

file_count_request()

Build a request to count files in OPFS.

file_exists_request(path)

Build a request to check whether a file exists in OPFS.

import_db_request(path, data)

Build a request to import a database file into OPFS.

init_request(opfs)

Build the OPFS initialization request.

list_files_request()

Build a request to list OPFS files.

new(opts \\ [])

Create an OPFS request builder configuration.

pool_capacity_request()

Build a request to inspect OPFS pool capacity.

Types

t()

@type t() :: %XmtpElixirSdk.BrowserShim.Opfs{enable_logging: boolean()}

Functions

clear_all_request()

@spec clear_all_request() :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to clear all OPFS-managed SDK files.

delete_file_request(path)

@spec delete_file_request(String.t()) :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to delete a file from OPFS.

export_db_request(path)

@spec export_db_request(String.t()) :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to export a database file from OPFS.

file_count_request()

@spec file_count_request() :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to count files in OPFS.

file_exists_request(path)

@spec file_exists_request(String.t()) :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to check whether a file exists in OPFS.

import_db_request(path, data)

@spec import_db_request(String.t(), binary()) ::
  XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to import a database file into OPFS.

init_request(opfs)

@spec init_request(t()) :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build the OPFS initialization request.

list_files_request()

@spec list_files_request() :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to list OPFS files.

new(opts \\ [])

@spec new(keyword()) :: t()

Create an OPFS request builder configuration.

pool_capacity_request()

@spec pool_capacity_request() :: XmtpElixirSdk.BrowserShim.Action.Request.t()

Build a request to inspect OPFS pool capacity.