Copyright	(c) 2023-2024 Apotheca Labs (c) 2024-2025 Haskell Foundation
License	BSD-3-Clause
Maintainer	joris@well-typed.com, leo@apotheca.io
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Botan.Low.Version

Description

This module is based on the Versioning section of the C Botan FFI documentation.

Synopsis

botanFFIAPIVersion :: IO Int
botanFFISupportsAPI :: Int -> IO Bool
botanVersionString :: IO ByteString
botanVersionMajor :: IO Int
botanVersionMinor :: IO Int
botanVersionPatch :: IO Int
botanVersionDatestamp :: IO Int

Documentation

botanFFIAPIVersion :: IO Int Source #

Returns the version of the currently supported FFI API. This is expressed in the form YYYYMMDD of the release date of this version of the API.

botanFFISupportsAPI :: Int -> IO Bool Source #

Returns True iff the FFI version specified is supported by this library, otherwise returns False.

The expression botanFFIAPIVersion >>= botanFFISupportsAPI will always evaluate to True. A particular version of the library may also support other (older) versions of the FFI API.

botanVersionString :: IO ByteString Source #

botanVersionMajor :: IO Int Source #

Returns the major version of the library

botanVersionMinor :: IO Int Source #

Returns the minor version of the library

botanVersionPatch :: IO Int Source #

Returns the patch version of the library

botanVersionDatestamp :: IO Int Source #

Returns the date this version was released as an integer YYYYMMDD, or 0 if an unreleased version