Module Protocol_9p.Response

Parsers and printers for 9P response messages

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

A variant including all possible 9P response payloads

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

    The tag used to match this response with the original request

    *)
  2. payload : payload;
}

A 9P protocol response

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

The size of a buffer needed to hold t

val read : Cstruct.t -> (t * Cstruct.t, [ `Msg of string ]) Stdlib.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.

val write : t -> Cstruct.t -> (Cstruct.t, [ `Msg of string ]) Stdlib.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.

val pp : t Fmt.t

pp pretty-prints responses.

val equal : t -> t -> bool

equal is the equality function over responses.

val sizeof_header : int

The size of the fixed response header

val error : ?errno:int32 -> ('a, unit, string, (_, Err.t) Stdlib.result) Stdlib.format4 -> 'a