Module OBus_string

module OBus_string: sig .. end

Restriction on strings used with D-Bus

There are a lot a various restrictions for strings used in D-Bus. Obus only verify strings when a message is sent or received

type error = {

`typ : string;`	`(*`	Type of string ("string", "bus name", "error name", "path", ...)	`*)`
`str : string;`	`(*`	The string which fail to validate	`*)`
`ofs : int;`	`(*`	is the position in byte where the validation failed	`*)`
`msg : string;`	`(*`	explain why the string failed to validate	`*)`

}

val error_message : error -> string

error_message error returns a human-readabe error message

Error projections

val typ : error -> string

val str : error -> string

val ofs : error -> int

val msg : error -> string

type validator = string -> error option

Function which test if a string is correct.

exception Invalid_string of error

val assert_validate : validator -> string -> unit

Raises OBus_string.Invalid_string if the given string failed to validate

type t = string

Type for common strings, restrictions are:

val validate : validator

Validatition function for commong strings