Lightning.Storage.ProjectFileDefinition (Lightning v2.19.0-pre)

This module provides functionality for managing the storage and retrieval of project files.

It handles operations related to storing project files, generating URLs for accessing these files, and constructing storage paths for exported files. It serves as an abstraction layer over the underlying storage mechanism provided by the Lightning.Storage module.

## Functions

store/2: Stores a file from a given source path into the storage system based on the file's path.
get_url/1: Retrieves the URL for accessing a stored file.
delete/1: Removes a stored file from the storage system.
storage_path_for_exports/2: Constructs a storage path for exported files, defaulting to a .zip extension.

## Example Usage

  # Store a file
  Lightning.Storage.ProjectFileDefinition.store("/path/to/source", project_file)

  # Get a URL for the stored file
  url = Lightning.Storage.ProjectFileDefinition.get_url(project_file)

  # Delete a stored file
  :ok = Lightning.Storage.ProjectFileDefinition.delete(project_file)

  # Get the storage path for an exported file
  path = Lightning.Storage.ProjectFileDefinition.storage_path_for_exports(project_file)

Summary

Functions

delete(file)

Deletes a file's object from storage.

get_url(file)

storage_path_for_exports(file, ext \\ ".zip")

store(source_path, file)

Functions

delete(file)

@spec delete(Lightning.Projects.File.t()) :: :ok | {:error, term()}

Deletes a file's object from storage.

Returns :ok once nothing is stored for the file, which includes the cases where there never was anything: a file with no path (a failed export never wrote one), and a path the backend doesn't recognise. Backends spell that last one differently — GCS answers 404, the local backend :enoent — and callers shouldn't have to know which backend they're on.

Anything else means the object may still be there, and comes back as {:error, reason}.

get_url(file)

storage_path_for_exports(file, ext \\ ".zip")