Packages

gossamer

7.0.0
10.0.0 9.2.0 9.1.0 9.0.0 8.5.0 8.4.0 8.3.0 8.2.0 8.1.0 8.0.0 7.0.0 6.8.0 6.7.0 6.6.0 6.5.0 6.4.0 6.3.0 6.2.0 6.1.0 6.0.0 5.0.0 4.1.0 4.0.1 4.0.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.0.0 1.0.1 1.0.0

Web Platform and ECMAScript API bindings for Gleam's JavaScript target

HexDocs

Current section

Files

Jump to
Readme
32 Versions
1 Dependency
Dependants
Files
Activity
gossamer src gossamer readable_stream byob_reader.gleam
Raw

src/gossamer/readable_stream/byob_reader.gleam 

// TODO: Untested — requires a byte stream (UnderlyingSource with type: "bytes")

// which gossamer doesn't expose yet. Add tests once byte stream support lands.



import gossamer/array_buffer.{type ArrayBufferView}

import gossamer/promise.{type Promise}

import gossamer/readable_stream/read_result.{type ReadResult}



@external(javascript, "./byob_reader.type.ts", "ByobReader$")

pub type ByobReader(a)



pub type ByobReaderReadOption {

  Min(Int)

}



@external(javascript, "./byob_reader.ffi.mjs", "closed")

pub fn closed(of reader: ByobReader(a)) -> Promise(Result(Nil, String))



@external(javascript, "./byob_reader.ffi.mjs", "cancel")

pub fn cancel(

  reader: ByobReader(a),

  reason reason: r,

) -> Promise(Result(Nil, String))



@external(javascript, "./byob_reader.ffi.mjs", "read")

pub fn read(

  reader: ByobReader(a),

  into view: ArrayBufferView,

  with options: List(ByobReaderReadOption),

) -> Promise(Result(ReadResult(ArrayBufferView), String))



@external(javascript, "./byob_reader.ffi.mjs", "release_lock")

pub fn release_lock(reader: ByobReader(a)) -> Result(ByobReader(a), String)