Struct S3OriginBuilder

pub struct S3OriginBuilder { /* private fields */ }

Implementations

impl S3OriginBuilder

pub fn new() -> Self

pub fn bucket(self, bucket: impl Into<String>) -> Self

Set the bucket name.

This is required.

pub fn prefix(self, prefix: impl Into<String>) -> Self

Set the bucket prefix.

This is optional, and defaults to an empty string.

pub fn client(self, client: S3Client) -> Self

Set the S3 client.

This is optional, and defaults to a new client created from the AWS SDK config.

pub fn prune_path(self, prune_path: usize) -> Self

Number of path components to remove from the request path.

This is useful for removing the bucket and prefix from the request path.

For example, if the request path is /stage/my-app/static/deployment/index.html, and the prune_path is 3, then the search key will be {bucket}/{bucket_prefix/}deployment/index.html.

pub fn config(self, config: AwsSdkConfig) -> Self

Set the AWS SDK config.

This is optional, and defaults to a new client created from the AWS SDK config. If client is not provided, the AWS SDK config must be provided.

pub fn max_size(self, max_size: i64) -> Self

Set the maximum size of the file to serve.

This is optional, and defaults to no maximum size. If the origin returns a file larger than the maximum size, an HTTP 413 (Payload Too Large) is returned.

pub fn build(self) -> Result<S3Origin, &'static str>

Build the S3 origin.

This will return an error a required parameter is not provided.

Trait Implementations

impl Default for S3OriginBuilder

fn default() -> Self

Returns the “default value” for a type.