package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Extracting strings
Extraction with blit
Appending strings
Inserting strings
Overwriting strings
Deleting
Searching
Miscelleneous

package gapi-ocaml

gapi-ocaml
gapi-ocaml.netstring-local
gapi-ocaml.netsys-local
- Netexn
- Netlog
  - Debug
- Netsys
  - Debug
- Netsys_conf
- Netsys_crypto_types
  - DIGESTS
  - FILE_TLS_ENDPOINT
    
    TLS
    
    Exc
  - PUBKEY_CRYPTO
  - SYMMETRIC_CRYPTO
  - TLS_CONFIG
    
    TLS
    
    Exc
  - TLS_ENDPOINT
    
    TLS
    
    Exc
  - TLS_EXCEPTIONS
  - TLS_PROVIDER
    
    Exc
- Netsys_impl_util
- Netsys_mem
- Netsys_oothr
  - condition
  - mtprovider
  - mutex
  - thread
- Netsys_posix
  - Debug
  - post_fork_handler
- Netsys_signal
  - Debug
- Netsys_tls
  - Debug
- Netsys_tmp
- Netsys_types
  - mstring
- Netsys_win32
  - Debug

Legend:
Library
Module
Module type
Parameter
Class
Class type

A Netbuffer.t is a buffer that can grow and shrink dynamically.

type t

val create : int -> t

Creates a netbuffer which allocates initially this number of bytes. * The logical length is zero.

val contents : t -> string

Returns the contents of the buffer as fresh string.

val to_bytes : t -> Stdlib.Bytes.t

Returns the contents of the buffer as fresh string.

val to_tstring_poly : t -> 's Netstring_tstring.tstring_kind -> 's

Return the buffer in the format as selected by the arg

val to_tstring : t -> _ Netstring_tstring.tstring_kind -> Netsys_types.tstring

Returns the buffer as tagged string, selecting the chosen representation

val length : t -> int

Returns the logical length of the buffer

Extracting strings

val get : t -> int -> char

get nb pos: Get the character at pos

val nth : t -> int -> char

Alias for get

val sub : t -> int -> int -> string

sub nb k n: returns the n characters starting at position n from * netbuffer nb as fresh string

val sub_bytes : t -> int -> int -> Stdlib.Bytes.t

Same for bytes

Extraction with blit

val blit_to_bytes : t -> int -> Stdlib.Bytes.t -> int -> int -> unit

blit_to_bytes nb srcpos dest destpos len: Copies the len bytes at * position srcpos from nb to the string dest at position destpos.

val blit_to_string : t -> int -> Stdlib.Bytes.t -> int -> int -> unit

deprecated
arg

val blit : t -> int -> Stdlib.Bytes.t -> int -> int -> unit

Compatibility name for blit_to_bytes

val blit_to_memory : t -> int -> Netsys_mem.memory -> int -> int -> unit

blit_to_memory nb srcpos dest destpos len: Copies the len bytes at * position srcpos from nb to the membuffer dest at position destpos.

val blit_to_tbuffer : t -> int -> Netsys_types.tbuffer -> int -> int -> unit

Blits to a tagged buffer

Appending strings

val add_string : t -> string -> unit

add_string nb s: Adds a copy of the string s to the logical end of * the netbuffer nb. If necessary, nb grows.

val add_bytes : t -> Stdlib.Bytes.t -> unit

Same for bytes

val add_tstring : t -> Netsys_types.tstring -> unit

Same for tagged string

val add_tstring_poly : t -> 's Netstring_tstring.tstring_ops -> 's -> unit

Polymorphic version

val add_substring : t -> string -> int -> int -> unit

add_substring nb s k n: Adds the substring of s starting at position * k with length n to the logical end of the netbuffer nb. If necessary, * nb grows. * * This is semantically the same as * add_string nb (String.sub s k n), but the extra copy is avoided.

val add_subbytes : t -> Stdlib.Bytes.t -> int -> int -> unit

Same for bytes

val add_subtstring : t -> Netsys_types.tstring -> int -> int -> unit

Same for tagged string

val add_sub_string : t -> string -> int -> int -> unit

deprecated
arg

val add_submemory : t -> Netsys_mem.memory -> int -> int -> unit

Same as add_substring, but gets data from a memory buffer

val add_sub_memory : t -> Netsys_mem.memory -> int -> int -> unit

deprecated
arg

val add_subtstring_poly : 
  t ->
  's Netstring_tstring.tstring_ops ->
  's ->
  int ->
  int ->
  unit

Polymorphic version

val add_char : t -> char -> unit

add_char nb c: Adds a single char at the end of the buffer

val add_char_2 : t -> char -> char -> unit

add_char_2 nb c1 c2: Adds two chars at the end of the buffer

val add_char_4 : t -> char -> char -> char -> char -> unit

add_char_4 nb c1 c2 c3 c4: Adds four chars at the end of the buffer

val add_inplace : ?len:int -> t -> (Stdlib.Bytes.t -> int -> int -> int) -> int

add_inplace nb f: Calls the function f to add bytes to the * netbuffer nb. The arguments of f are the buffer, the position * in the buffer, and the maximum length. The function f must return * the actual number of added bytes; this number is also returned by * add_inplace. * * Example: let n = add_inplace nb (Pervasives.input ch) * * The argument len is the number of bytes to add (second argument of * f). It defaults to the number of free bytes in the buffer after space * for at least one byte has been allocated.

val add_buffer : t -> t -> unit

add_buffer nb1 nb2: Adds the contents of nb2 to the end of nb1

val area_for_additions : ?len:int -> t -> Stdlib.Bytes.t * int * int

val advance : t -> int -> unit

These two functions work together, so that the effect of add_inplace can be obtained in two steps. First, the user calls

let (s,pos,len) = area_for_additions nb

to get the area where to put new data of length n, with n <= len. After this the data is made valid by

advance n

Inserting strings

val insert_string : t -> int -> string -> unit

insert_string nb p s: Inserts the value of string s at position * p into the netbuffer nb

val insert_substring : t -> int -> string -> int -> int -> unit

insert_string nb p s k n: Inserts a substring of string s at position * p into the netbuffer nb. The substring is denoted by position k * and has length n

val insert_sub_string : t -> int -> string -> int -> int -> unit

deprecated
arg

val insert_subbytes : t -> int -> Stdlib.Bytes.t -> int -> int -> unit

Same for bytes

val insert_subtstring : t -> int -> Netsys_types.tstring -> int -> int -> unit

Same for tagged string

val insert_submemory : t -> int -> Netsys_types.memory -> int -> int -> unit

Same for memory

val insert_char : t -> int -> char -> unit

insert_char nb p c: Inserts character c at position p into * the netbuffer nb

Overwriting strings

val set : t -> int -> char -> unit

set nb pos c: Sets the character at pos to c

val put_string : t -> int -> string -> unit

put_string nb pos s: Copies the string s to the position pos of netbuffer nb

val blit_from_string : string -> int -> t -> int -> int -> unit

blit_from_string src srcpos dest destpos len: Copies the len bytes * at position srcpos from the string src to the netbuffer dest at * position destpos. * * It is possible to copy the string beyond the end of the buffer. The * buffer is automatically enlarged in this case.

val blit_from_bytes : Stdlib.Bytes.t -> int -> t -> int -> int -> unit

Same for bytes

val blit_from_memory : Netsys_types.memory -> int -> t -> int -> int -> unit

Same for memory

val blit_from_tstring : Netsys_types.tstring -> int -> t -> int -> int -> unit

Same for tagged string

Deleting

val delete : t -> int -> int -> unit

delete nb k n: Deletes the n bytes at position k of netbuffer * nb in-place. * * The netbuffer does not shrink, however, i.e. the free space is not * given back to the memory manager.

val clear : t -> unit

Deletes all contents from the buffer. As delete, the netbuffer does * not shrink.

val reset : t -> unit

Empty the buffer, deallocate the internal string, and replace it with a new string of length n that was allocated by Netbuffer.create n.

val try_shrinking : t -> unit

try_shrinking nb: If the length of the buffer is less than half of * the allocated space, the netbuffer is reallocated in order to save * memory.

Searching

val index_from : t -> int -> char -> int

index_from nb k c: Searches the character c in the netbuffer beginning * at position k. If found, the position of the left-most occurence is * returned. Otherwise, Not_found is raised.

Miscelleneous

val unsafe_buffer : t -> Stdlib.Bytes.t

Warning! This is a low-level function! * Returns the current string that internally holds the buffer. * The byte positions 0 to length - 1 actually store the contents of * the buffer. You can directly read and modify the buffer. Note that * there is no protection if you read or write positions beyond the * length of the buffer.

val print_buffer : t -> unit

For the toploop