package protocol-9p

  1. Overview
  2. Docs

Module Protocol_9p.RequestSource

Parsers and printers for all 9P request messages.

Sourcemodule Version : sig ... end
Sourcemodule Auth : sig ... end
Sourcemodule Flush : sig ... end
Sourcemodule Attach : sig ... end
Sourcemodule Walk : sig ... end
Sourcemodule Open : sig ... end
Sourcemodule Create : sig ... end
Sourcemodule Read : sig ... end
Sourcemodule Write : sig ... end
Sourcemodule Clunk : sig ... end
Sourcemodule Remove : sig ... end
Sourcemodule Stat : sig ... end
Sourcemodule Wstat : sig ... end
Sourcetype payload =
  1. | Version of Version.t
  2. | Auth of Auth.t
  3. | Flush of Flush.t
  4. | Attach of Attach.t
  5. | Walk of Walk.t
  6. | Open of Open.t
  7. | Create of Create.t
  8. | Read of Read.t
  9. | Write of Write.t
  10. | Clunk of Clunk.t
  11. | Remove of Remove.t
  12. | Stat of Stat.t
  13. | Wstat of Wstat.t

A variant type containing all possible request payloads

Sourceval sexp_of_payload : payload -> Sexplib0.Sexp.t
Sourceval payload_of_sexp : Sexplib0.Sexp.t -> payload
Sourcetype t = {
  1. tag : Protocol_9p__.Protocol_9p_types.Tag.t;
    (*

    The tag used to match the response with the original request

    *)
  2. payload : payload;
}

A 9P protocol request

include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval sizeof : t -> int

The size of a buffer needed to hold t

Sourceval read : Cstruct.t -> (t * Cstruct.t, [ `Msg of string ]) result

Read a t from the given buffer and return it, along with the unused remainder of the buffer. If the buffer cannot be parsed then return an error.

Sourceval write : t -> Cstruct.t -> (Cstruct.t, [ `Msg of string ]) result

Write a t into the given buffer. If the buffer is too small, then return an error. Return the unused remainder of the buffer.

Sourceval read_header : Cstruct.t -> (int * Protocol_9p__.Protocol_9p_types.Tag.t * Cstruct.t, [ `Msg of string ]) result
Sourceval sizeof_header : int

The size of the fixed request header

Sourceval pp : t Fmt.t

pp formats request.

Sourceval equal : t -> t -> bool

equal is the equality function for requests.