package obus

You can search for identifiers within the package.

in-package search v0.2.0

Pure Ocaml implementation of the D-Bus protocol

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (6)

Authors

J

Jérémie Dimino

Maintainers

F

freyrnjordrson@gmail.com

Sources

1.2.3.tar.gz

sha256=75703f78015e15d03d0fdba1633a155875daf17d854225658429e72a0df06258

md5=3090a796f0af95e16838d81656ac4b97

doc/obus.internals/OBus_string/index.html

Module `OBus_string`Source

Restriction on strings used with D-Bus

There are a lot of restrictions for strings used in D-Bus. OBus only verifies strings when a message is sent or received

Sourcetype 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 bytes where the validation failed
*)
msg : string;
(*
explains why the string failed to validate
*)

}

Sourceval error_message : error -> string

error_message error returns a human-readable error message

Error projections

Sourceval typ : error -> string

Sourceval str : error -> string

Sourceval ofs : error -> int

Sourceval msg : error -> string

Validators

Sourcetype validator = string -> error option

Tests if a string is correct.

if it is, returns None
if not, returns Some(ofs, msg)

Sourceexception Invalid_string of error

Sourceval assert_validate : validator -> string -> unit

Raises Invalid_string if the given string failed to validate

Common strings

Sourcetype t = string

Type for common strings, restrictions are:

a string must be encoded in valid UTF-8
a string must not contains the null byte

Sourceval validate : validator

Validation function for common strings

On This Page

Error projections
Validators
Common strings