• OCaml logo OCaml logo
  • Learn
  • Packages
  • Community
  • Blog
  • Playground
  • Learn
  • Packages
  • Community
  • Blog
  • Playground
  • Get started
  • protocol-9p
  • Documentation
  • protocol_9p lib
  • Protocol_9p .Types .Arr .T Parameter #1
package protocol-9p
  • protocol_9p
    • Protocol_9p
      • Buffered9PReader
        • Make
          • 1-Log
          • 2-FLOW
      • Client
        • Make
          • 1-Log
          • 2-FLOW
          • KV_RO
          • LowLevel
        • S
          • KV_RO
          • LowLevel
      • Error
      • Filesystem
        • S
      • Infix
      • Info
      • Request
        • Attach
        • Auth
        • Clunk
        • Create
        • Flush
        • Open
        • Read
        • Remove
        • Stat
        • Version
        • Walk
        • Write
        • Wstat
      • Response
        • Attach
        • Auth
        • Clunk
        • Create
        • Err
        • Flush
        • Open
        • Read
        • Remove
        • Stat
        • Version
        • Walk
        • Write
        • Wstat
      • S
        • LOG
        • SERIALISABLE
      • Server
        • Make
          • 1-Log
          • 2-FLOW
          • 3-Filesystem
      • Types
        • Arr
          • 1-T
        • Data
        • Fid
          • Map
          • Set
        • FileMode
        • Int16
        • Int32
        • Int64
        • Int8
        • OpenMode
        • Qid
        • Stat
        • Tag
          • Map
          • Set
        • Version
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

Instances of this type can be read and written

val sizeof : t -> int

The size of a buffer needed to hold t

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

Footer

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS

About Us

  • Industrial Users
  • Academic Users
  • Why OCaml

Resources

  • Get Started
  • Language Manual
  • Standard Library API
  • Books
  • Releases

Community

  • Blog
  • Jobs

Policies

  • Carbon Footprint
  • Governance
  • Privacy
  • Code of Conduct