🥮 mooncakes.io

    moonbitstack/moonquic/frame does not have a README file

    Refused

    source
    pub(all) suberror Refused {
      Malformed(String)
    } derive(Eq)

    A malformed ACK frame: its fields do not describe a packet-number set.
    impl Show for Refused

    Refused::equal

    source
    fn Refused::equal(Refused, Refused) -> Bool

    Refused::not_equal

    source
    fn Refused::not_equal(x : Refused, y : Refused) -> Bool

    Refused::output

    source
    fn Refused::output(self : Refused, logger : &Logger) -> Unit

    Refused::to_string

    source
    fn Refused::to_string(self : Refused) -> String

    Frame

    source
    pub(all) enum Frame {
      Padding(Int)
      Ping
      Crypto(offset~ : UInt64, data~ : Bytes)
      Stream(id~ : UInt64, offset~ : UInt64, fin~ : Bool, data~ : Bytes)
      Datagram(data~ : Bytes)
      Ack(largest~ : UInt64, delay~ : UInt64, first_range~ : UInt64, ranges~ : Array[(UInt64, UInt64)])
      AckEcn(largest~ : UInt64, delay~ : UInt64, first_range~ : UInt64, ranges~ : Array[(UInt64, UInt64)], ect0~ : UInt64, ect1~ : UInt64, ce~ : UInt64)
      ResetStream(id~ : UInt64, error_code~ : UInt64, final_size~ : UInt64)
      StopSending(id~ : UInt64, error_code~ : UInt64)
      NewToken(token~ : Bytes)
      MaxData(UInt64)
      MaxStreamData(id~ : UInt64, max~ : UInt64)
      MaxStreams(bidi~ : Bool, max~ : UInt64)
      DataBlocked(UInt64)
      StreamDataBlocked(id~ : UInt64, max~ : UInt64)
      StreamsBlocked(bidi~ : Bool, max~ : UInt64)
      NewConnectionId(seq~ : UInt64, retire_prior_to~ : UInt64, conn_id~ : Bytes, reset_token~ : Bytes)
      RetireConnectionId(UInt64)
      PathChallenge(Bytes)
      PathResponse(Bytes)
      HandshakeDone
      ConnectionClose(error_code~ : UInt64, frame_type~ : UInt64?, reason~ : Bytes)
      PathAck(path_id~ : UInt64, largest~ : UInt64, delay~ : UInt64, first_range~ : UInt64, ranges~ : Array[(UInt64, UInt64)])
      PathAckEcn(path_id~ : UInt64, largest~ : UInt64, delay~ : UInt64, first_range~ : UInt64, ranges~ : Array[(UInt64, UInt64)], ect0~ : UInt64, ect1~ : UInt64, ce~ : UInt64)
      PathAbandon(path_id~ : UInt64, error_code~ : UInt64)
      PathStatus(path_id~ : UInt64, seq~ : UInt64, available~ : Bool)
      PathNewConnectionId(path_id~ : UInt64, seq~ : UInt64, retire_prior_to~ : UInt64, conn_id~ : Bytes, reset_token~ : Bytes)
      PathRetireConnectionId(path_id~ : UInt64, seq~ : UInt64)
      MaxPathId(max~ : UInt64)
      PathsBlocked(max~ : UInt64)
      PathCidsBlocked(path_id~ : UInt64, next~ : UInt64)
    } derive(Eq, 
    Debug    )

    A decoded QUIC frame. Padding collapses a run of zero bytes to its length; Stream carries application data on a stream, with a byte offset and a fin flag marking the end of the stream (RFC 9000 §19.8).

    Frame::acked

    source
    fn Frame::acked(self : Frame) -> Array[(UInt64, UInt64)] raise Refused

    The packet numbers an ACK or ACK_ECN frame acknowledges, as ascending inclusive ranges; empty for every other frame.

    Frame::equal

    source
    fn Frame::equal(Frame, Frame) -> Bool

    Frame::not_equal

    source
    fn Frame::not_equal(x : Frame, y : Frame) -> Bool

    Frame::to_repr

    source

    Seen

    source
    pub struct Seen {
      runs : Array[(UInt64, UInt64)]
    }

    The packet numbers seen, held as ascending, non-overlapping, non-adjacent inclusive runs [lo, hi].

    Seen::add

    source
    fn Seen::add(self : Seen, pn : UInt64) -> Unit

    Record that packet number pn arrived. Out-of-order and duplicate numbers are absorbed: the runs stay ascending and disjoint however they come in.

    Seen::contains

    source
    fn Seen::contains(self : Seen, pn : UInt64) -> Bool

    Whether packet number pn has been received.

    Seen::fields

    source
    fn Seen::fields(self : Seen) -> (UInt64, UInt64, Array[(UInt64, UInt64)])?

    The ACK frame fields for the current set: the Largest Acknowledged, the First ACK Range (how many contiguous packets below the largest are acked), and the descending (Gap, ACK Range Length) list. None when nothing has been received.

    Seen::is_empty

    source
    fn Seen::is_empty(self : Seen) -> Bool

    Whether nothing has been received.

    Seen::largest

    source
    fn Seen::largest(self : Seen) -> UInt64?

    The largest packet number received, or None when empty.

    Seen::new

    source
    fn Seen::new() -> Seen

    An empty set: nothing received yet.

    Seen::ranges

    source
    fn Seen::ranges(self : Seen) -> Array[(UInt64, UInt64)]

    The packet numbers as ascending inclusive ranges.

    Seen::read

    source
    fn Seen::read(largest : UInt64, first_range : UInt64, pairs : Array[(UInt64, UInt64)]) -> Seen raise Refused

    The set an ACK frame's fields describe, the inverse of fields.

    decode

    source
    fn decode(b : BytesView) -> (Frame, Int) raise Refused

    Read one frame at the start of b, returning it and the bytes it occupied, or raise Refused when it is truncated or of a type this codec does not know. A PADDING frame absorbs the whole run of leading zero bytes.

    This is the strict face; a caller that would rather branch on the outcome can keep the Option form, but the connection reads payloads through this so a malformed frame is one error path rather than two.

    elicits_ack

    source
    fn elicits_ack(frame : Frame) -> Bool

    Whether a single frame is ack-eliciting (RFC 9000 §13.2.1): every frame except PADDING, ACK, ACK_ECN, and CONNECTION_CLOSE obliges the peer to acknowledge the packet.

    encode

    source
    fn encode(f : Frame) -> Bytes

    Encode a frame to its wire bytes.

    Source Files