gflare - v1.0.0

gflare/r2

Types

Bucket

</> 
pub type Bucket

HttpMetadata

</> 
pub type HttpMetadata {
  HttpMetadata(
    content_type: option.Option(String),
    content_disposition: option.Option(String),
    content_encoding: option.Option(String),
    cache_control: option.Option(String),
    cache_expiry: option.Option(Int),
  )
}

Constructors

ListObject

</> 
pub type ListObject {
  ListObject(
    key: String,
    version: String,
    size: Int,
    etag: String,
    uploaded: String,
  )
}

Constructors 

  • ListObject(
  key: String,
  version: String,
  size: Int,
  etag: String,
  uploaded: String,
)

ListOptions

</> 
pub type ListOptions {
  ListOptions(
    prefix: option.Option(String),
    cursor: option.Option(String),
    delimiter: option.Option(String),
    limit: option.Option(Int),
    include: option.Option(List(String)),
  )
}

Constructors

ListResult

</> 
pub type ListResult {
  ListResult(
    objects: List(ListObject),
    truncated: Bool,
    cursor: option.Option(String),
    delimited_prefixes: List(String),
  )
}

Constructors 

  • ListResult(
  objects: List(ListObject),
  truncated: Bool,
  cursor: option.Option(String),
  delimited_prefixes: List(String),
)

ObjectBody

</> 
pub type ObjectBody

PutOptions

</> 
pub type PutOptions {
  PutOptions(
    http_metadata: option.Option(HttpMetadata),
    custom_metadata: option.Option(List(#(String, String))),
  )
}

Constructors

R2ObjectResult

</> 
pub type R2ObjectResult {
  R2ObjectResult(
    key: String,
    version: String,
    size: Int,
    etag: String,
    uploaded: String,
  )
}

Constructors 

  • R2ObjectResult(
  key: String,
  version: String,
  size: Int,
  etag: String,
  uploaded: String,
)

Values

delete

</> 
pub fn delete(
  bucket: Bucket,
  key: String,
) -> promise.Promise(Result(Nil, error.Error))

get

</> 
pub fn get(
  bucket: Bucket,
  key: String,
) -> promise.Promise(Result(ObjectBody, error.Error))

get_metadata

</> 
pub fn get_metadata(
  bucket: Bucket,
  key: String,
) -> promise.Promise(Result(R2ObjectResult, error.Error))
</> 
pub fn head(
  bucket: Bucket,
  key: String,
) -> promise.Promise(Result(R2ObjectResult, error.Error))

list

</> 
pub fn list(
  bucket: Bucket,
  options: ListOptions,
) -> promise.Promise(Result(ListResult, error.Error))

list_options

</> 
pub fn list_options() -> ListOptions

list_options_with

</> 
pub fn list_options_with(
  prefix: option.Option(String),
  cursor: option.Option(String),
  delimiter: option.Option(String),
  limit: option.Option(Int),
  include: option.Option(List(String)),
) -> ListOptions

put

</> 
pub fn put(
  bucket: Bucket,
  key: String,
  body: BitArray,
  options: PutOptions,
) -> promise.Promise(Result(R2ObjectResult, error.Error))

put_options

</> 
pub fn put_options() -> PutOptions

put_options_with

</> 
pub fn put_options_with(
  http_metadata meta: option.Option(HttpMetadata),
  custom_metadata cm: option.Option(List(#(String, String))),
) -> PutOptions

read_bytes

</> 
pub fn read_bytes(
  body: ObjectBody,
) -> promise.Promise(Result(BitArray, error.Error))

read_json

</> 
pub fn read_json(
  body: ObjectBody,
) -> promise.Promise(Result(dynamic.Dynamic, error.Error))

read_text

</> 
pub fn read_text(
  body: ObjectBody,
) -> promise.Promise(Result(String, error.Error))
✨ Search Document