API Reference firkin v#0.2.1

Copy Markdown View Source

Modules

A Plug-based library for building S3-compatible object storage APIs.

S3 Signature Version 4 authentication.

AWS Signature Version 4 implementation for server-side verification.

Behaviour for S3 storage backends.

Reference implementation of Firkin.Backend — stores credentials, buckets, objects, and multipart uploads in a named ETS table.

Represents an S3 bucket in listing responses.

Result of a CompleteMultipartUpload operation.

Result of a CopyObject operation.

Represents an S3 credential pair with an opaque identity.

Result of a DeleteObjects (batch delete) operation.

S3 error representation.

Options for GetObject, including range and conditional request headers.

Options for ListObjectsV2.

Result of a ListObjectsV2 operation.

Result of a ListMultipartUploads operation.

Represents an S3 object returned by GetObject.

Object metadata returned by HeadObject and used in ListObjectsV2 entries.

Result of a ListParts operation.

Plug that serves an S3-compatible HTTP API.

Options for PutObject.

Telemetry events emitted by Firkin.

XML generation and parsing for S3 protocol messages.

Mix Tasks

Starts a Bandit HTTP server serving Firkin.Plug, suitable for poking at Firkin with aws CLI, mc, or any other S3 client.