package swhid_core

You can search for identifiers within the package.

in-package search v0.2.0

package swhid_core

swhid_core
- Swhid_core
  - Compute
    
    Make
    
    OS
    
    SHA1
  - Object
    
    Core_identifier
    
    Hash
    
    Kind
    
    Qualifier
    
    Scheme_version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Module to work with the different kinds of software artifacts a swhid can points to. They're documented here.

type t =

| Content of string
(*
Contents (AKA "blobs"). the string parameter is the name of the hash function used for the computation, defaults to "sha1_git" and in most use cases you don't care about it.
*)
| Directory
(*
Directories.
*)
| Revision
(*
Revisions.
*)
| Release
(*
Releases.
*)
| Snapshot
(*
Snapshots.
*)

The type of the different kinds of software artifacts.

val compare : t -> t -> int

compare x y returns 0 if x is equal to y, a negative integer if x is less than y, and a positive integer if x is greater than y.

val equal : t -> t -> bool

equal x y returns true iff x is equal to y.

val of_string : string -> (t, string) result

of_string s is Ok v if s is a valid kind of object, otherwise it is Error e. The valid kinds are "cnt", "dir", "rel", "rev" and "snp".

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

pp fmt v prints v on formatter fmt.

val to_string : t -> string

to_string v is the representation of v as a string.