Module `Gpx.Link`Source

Links, persons, and copyright information

The Link module handles web links, author information, and copyright data as defined in the GPX specification. This includes:

Web links with optional text and MIME type
Person records with name, email, and associated links
Copyright information with author, year, and license terms

Link and person information types

Sourcetype t = {

href : string;
text : string option;
type_ : string option;

}

Main link type

Sourceand person = {

name : string option;
email : string option;
link : t option;

}

Person information

Sourceand copyright = {

author : string;
year : int option;
license : string option;

}

Link Operations

Sourceval make : href:string -> ?text:string -> ?type_:string -> unit -> t

Create a link.

parameter href
URL reference (required)

parameter ?text
Optional link text

parameter ?type_
Optional MIME type

Sourceval href : t -> string

Get href from link

Sourceval text : t -> string option

Get optional text from link

Sourceval type_ : t -> string option

Get optional type from link

Sourceval with_text : t -> string -> t

Update text

Sourceval with_type : t -> string -> t

Update type

Sourceval compare : t -> t -> int

Compare links

Sourceval equal : t -> t -> bool

Test link equality

Sourceval pp : Format.formatter -> t -> unit

Pretty print link

Person Operations

Sourceval make_person : ?name:string -> ?email:string -> ?link:t -> unit -> person

Create person information

Sourceval person_name : person -> string option

Get person name

Sourceval person_email : person -> string option

Get person email

Sourceval person_link : person -> t option

Get person link

Sourceval compare_person : person -> person -> int

Compare persons

Sourceval equal_person : person -> person -> bool

Test person equality

Sourceval pp_person : Format.formatter -> person -> unit

Pretty print person

Copyright Operations

Source

val make_copyright : 
  author:string ->
  ?year:int ->
  ?license:string ->
  unit ->
  copyright

Create copyright information

Sourceval copyright_author : copyright -> string

Get copyright author

Sourceval copyright_year : copyright -> int option

Get copyright year

Sourceval copyright_license : copyright -> string option

Get copyright license

Sourceval compare_copyright : copyright -> copyright -> int

Compare copyrights

Sourceval equal_copyright : copyright -> copyright -> bool

Test copyright equality

Sourceval pp_copyright : Format.formatter -> copyright -> unit

package mlgpx

Module Gpx.LinkSource

Links, persons, and copyright information

Link Operations

Person Operations

Copyright Operations

Module `Gpx.Link`Source