package protocol-9p

You can search for identifiers within the package.

in-package search v0.2.0

An implementation of the 9p protocol in pure OCaml

Install

dune-project

Dependency

github.com Readme Changelog ISC License Edit opam file Versions (13)

Authors

Maintainers

D

dave@recoil.org

Sources

protocol-9p-2.1.0.tbz

sha256=28bace4c680708495bf3f8c936ade387870887c39c507318ecab456bf8824845

sha512=5c4a421211e84ddc2a4588d3d7d1979de83e32e8e5cde926ea0c93272720b67f009ead0ad51d087a62bffbad884390f02e030752c435f442115ee82ce932b741

doc/protocol-9p/Protocol_9p/Response/index.html

Module `Protocol_9p.Response`Source

Parsers and printers for 9P response messages

Sourcemodule Version : sig ... end

Sourcemodule Auth : sig ... end

Sourcemodule Err : 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 =

| Version of Version.t
| Auth of Auth.t
| Err of Err.t
| Flush of Flush.t
| Attach of Attach.t
| Walk of Walk.t
| Open of Open.t
| Create of Create.t
| Read of Read.t
| Write of Write.t
| Clunk of Clunk.t
| Remove of Remove.t
| Stat of Stat.t
| Wstat of Wstat.t

A variant including all possible 9P response payloads

Sourceval sexp_of_payload : payload -> Sexplib0.Sexp.t

Sourceval payload_of_sexp : Sexplib0.Sexp.t -> payload

Sourcetype t = {

tag : Protocol_9p__.Protocol_9p_types.Tag.t;
(*
The tag used to match this response with the original request
*)
payload : payload;

}

A 9P protocol response

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 pp : t Fmt.t

pp pretty-prints responses.

Sourceval equal : t -> t -> bool

equal is the equality function over responses.

Sourceval sizeof_header : int

The size of the fixed response header

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