bucket/list_objects

Types

ListObjectsResult

pub type ListObjectsResult {
  ListObjectsResult(is_truncated: Bool, contents: List(Object))
}

Constructors

ListObjectsResult(is_truncated: Bool, contents: List(Object))

Object

</>

pub type Object {
  Object(
    key: String,
    last_modified: String,
    etag: String,
    size: Int,
  )
}

Constructors

Object(
  key: String,
  last_modified: String,
  etag: String,
  size: Int,
)

RequestBuilder

</>

The parameters for the API request

pub type RequestBuilder {
  RequestBuilder(
    bucket: String,
    prefix: option.Option(String),
    start_after: option.Option(String),
    max_keys: option.Option(Int),
  )
}

Constructors

RequestBuilder(
  bucket: String,
  prefix: option.Option(String),
  start_after: option.Option(String),
  max_keys: option.Option(Int),
)

Values

build

</>

pub fn build(
  builder: RequestBuilder,
  creds: bucket.Credentials,
) -> request.Request(BitArray)

prefix

</>

pub fn prefix(
  builder: RequestBuilder,
  prefix: String,
) -> RequestBuilder

Limits the response to keys that begin with the specified prefix.

request

</>

pub fn request(bucket: String) -> RequestBuilder

response

</>

pub fn response(
  response: response.Response(BitArray),
) -> Result(ListObjectsResult, bucket.BucketError)

start_after

</>

pub fn start_after(
  builder: RequestBuilder,
  key: String,
) -> RequestBuilder

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.