frame

Types

ConnectionError

pub type ConnectionError {
  NoError
  ProtocolError
  InternalError
  FlowControlError
  SettingsTimeout
  StreamClosed
  FrameSizeError
  RefusedStream
  Cancel
  CompressionError
  ConnectError
  EnhanceYourCalm
  InadequateSecurity
  Http11Required
  Unsupported(Int)
}

Constructors

```
NoError
```
```
ProtocolError
```
```
InternalError
```
```
FlowControlError
```
```
SettingsTimeout
```
```
StreamClosed
```
```
FrameSizeError
```
```
RefusedStream
```
```
Cancel
```
```
CompressionError
```
```
ConnectError
```
```
EnhanceYourCalm
```
```
InadequateSecurity
```
```
Http11Required
```
```
Unsupported(Int)
```

Data

</>

pub type Data {
  Complete(BitArray)
  Continued(BitArray)
}

Constructors

```
Complete(BitArray)
```
```
Continued(BitArray)
```

Frame

</>

pub type Frame {
  Data(
    data: BitArray,
    end_stream: Bool,
    identifier: StreamIdentifier(Frame),
  )
  Header(
    data: Data,
    end_stream: Bool,
    identifier: StreamIdentifier(Frame),
    priority: option.Option(HeaderPriority),
  )
  Priority(
    exclusive: Bool,
    identifier: StreamIdentifier(Frame),
    stream_dependency: StreamIdentifier(Frame),
    weight: Int,
  )
  Termination(
    error: ConnectionError,
    identifier: StreamIdentifier(Frame),
  )
  Settings(ack: Bool, settings: List(Setting))
  PushPromise(
    data: Data,
    identifier: StreamIdentifier(Frame),
    promised_stream_id: StreamIdentifier(Frame),
  )
  Ping(ack: Bool, data: BitArray)
  GoAway(
    data: BitArray,
    error: ConnectionError,
    last_stream_id: StreamIdentifier(Frame),
  )
  WindowUpdate(amount: Int, identifier: StreamIdentifier(Frame))
  Continuation(data: Data, identifier: StreamIdentifier(Frame))
  Unknown(frame_type: Int)
}

Constructors

Data(
  data: BitArray,
  end_stream: Bool,
  identifier: StreamIdentifier(Frame),
)

Header(
  data: Data,
  end_stream: Bool,
  identifier: StreamIdentifier(Frame),
  priority: option.Option(HeaderPriority),
)

Priority(
  exclusive: Bool,
  identifier: StreamIdentifier(Frame),
  stream_dependency: StreamIdentifier(Frame),
  weight: Int,
)

Termination(
  error: ConnectionError,
  identifier: StreamIdentifier(Frame),
)

Settings(ack: Bool, settings: List(Setting))

PushPromise(
  data: Data,
  identifier: StreamIdentifier(Frame),
  promised_stream_id: StreamIdentifier(Frame),
)

```
Ping(ack: Bool, data: BitArray)
```

GoAway(
  data: BitArray,
  error: ConnectionError,
  last_stream_id: StreamIdentifier(Frame),
)

WindowUpdate(amount: Int, identifier: StreamIdentifier(Frame))

Continuation(data: Data, identifier: StreamIdentifier(Frame))

```
Unknown(frame_type: Int)
```

HeaderPriority

</>

pub type HeaderPriority {
  HeaderPriority(
    exclusive: Bool,
    stream_dependency: StreamIdentifier(Frame),
    weight: Int,
  )
}

Constructors

HeaderPriority(
  exclusive: Bool,
  stream_dependency: StreamIdentifier(Frame),
  weight: Int,
)

PushState

</>

pub type PushState {
  Enabled
  Disabled
}

Constructors

```
Enabled
```
```
Disabled
```

Setting

</>

pub type Setting {
  HeaderTableSize(Int)
  ServerPush(PushState)
  MaxConcurrentStreams(Int)
  InitialWindowSize(Int)
  MaxFrameSize(Int)
  MaxHeaderListSize(Int)
}

Constructors

```
HeaderTableSize(Int)
```
```
ServerPush(PushState)
```
```
MaxConcurrentStreams(Int)
```
```
InitialWindowSize(Int)
```
```
MaxFrameSize(Int)
```
```
MaxHeaderListSize(Int)
```

StreamIdentifier

opaque </>

pub opaque type StreamIdentifier(phantom)

Values

decode

</>

pub fn decode(
  frame: BitArray,
) -> Result(#(Frame, BitArray), ConnectionError)

encode

</>

pub fn encode(frame: Frame) -> BitArray

get_stream_identifier

</>

pub fn get_stream_identifier(
  identifier: StreamIdentifier(phantom),
) -> Int

settings_ack

</>

pub fn settings_ack() -> Frame

stream_identifier

</>

pub fn stream_identifier(value: Int) -> StreamIdentifier(Frame)