ankh v0.4.3 Ankh.Frame
HTTP/2 frame struct
The using macro injects the frame struct needed by Ankh.Frame
.
Link to this section Summary
Functions
Injects the frame struct in a module
Decodes a binary into a frame struct
Encodes a frame struct into binary
Link to this section Types
Encode/Decode options
Struct injected by the Ankh.Frame
using macro.
Link to this section Functions
Link to this macro
__using__(args)
(macro)
__using__( type: Integer.t(), flags: Ankh.Frame.Encodable.t(), payload: Ankh.Frame.Encodable.t() ) :: Macro.t()
Injects the frame struct in a module.
- type: HTTP/2 frame type code
- flags: frame flags struct or nil for no flags
- payload: frame payload struct or nil for no payload
Decodes a binary into a frame struct
Parameters:
- struct: struct using
Ankh.Frame
- binary: data to decode into the struct
- options: options to pass as context to the decoding function
Encodes a frame struct into binary
Parameters:
- struct: struct using
Ankh.Frame
- options: options to pass as context to the encoding function