package protocol-9p

  1. Overview
  2. Docs
package protocol-9p
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Types.FidSource

Sourcetype t
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourcemodule Set : Set.S with type elt = t
Sourcemodule Map : Map.S with type key = t
Sourceval nofid : t
Sourceval of_int32 : int32 -> (t, [ `Msg of string ]) result
Sourceval to_int32 : t -> int32

A list of recommended fids. The client can allocate (on the server) up to 2^32 distinct fids (in theory) but this is obviously a bad thing to do. Instead clients are recommended to use fids from this (much smaller) list.

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.