Commit 9475449a authored by Alberto Ramos's avatar Alberto Ramos

Modular structure. Updated documentation

parent dfd086fb
using Documenter, BDIO
makedocs(modules=[BDIO], doctest=true)
makedocs(modules=[BDIO], doctest=true, sitename = "BDIO meets Julia")
deploydocs(deps = Deps.pip("mkdocs", "python-markdown-math"),
repo = "github.com/GITHUBNAME/GITHUBREPO.git",
......
# BDIO in Julia
This package provides an interface to read/write
[BDIO](http://bdio.org/) files in Julia.
[BDIO](http://bdio.org/) (**B**inary **D**ata **I**nput/**O**utput)
files in Julia.
## Index
```@index
```
## Externally callable functions
### Setting up global information
```@docs
BDIO.BDIO_set_user
BDIO.BDIO_set_host
```
### Openning `BDIO` files
```@docs
......@@ -34,7 +47,3 @@ BDIO.BDIO_get_len
BDIO.BDIO_get_fmt
```
## Index
```@index
```
This diff is collapsed.
This diff is collapsed.
mutable struct Record
ishdr::Bool
islong::Bool
# Record length, start, end
rlen::Int64
rpos::Int64
rend::Int64
rfmt::Int32
ruinfo::Int8
hsh::Nettle.Hasher
end
mutable struct BDIOstream
io::IO
ipt::Int64
imode::Int32
istate::Int32
rwpos::Int64
lendian::Bool
user::String
host::String
created::Int32
modified::Int32
info::String
rdate::Int64
records::Array{Record,1}
end
const BDIO_R_MODE = 0
const BDIO_W_MODE = 1
const BDIO_A_MODE = 2
const BDIO_D_MODE = 3
const MAXFNAME = 4096
const BDIO_SHORT_LEN = 256
const BDIO_LONG_LEN = 4096
const BDIO_MAGIC = 2147209342
const BDIO_VERSION = 1
const BDIO_R_STATE = 0
const BDIO_W_STATE = 1
const BDIO_BIN_GENERIC = 0
const BDIO_ASC_EXEC = 1
const BDIO_BIN_INT32BE = 2
const BDIO_BIN_INT32LE = 3
const BDIO_BIN_INT64BE = 4
const BDIO_BIN_INT64LE = 5
const BDIO_BIN_F32BE = 6
const BDIO_BIN_F32LE = 7
const BDIO_BIN_F64BE = 8
const BDIO_BIN_F64LE = 9
const BDIO_ASC_GENERIC = 10
const BDIO_ASC_XML = 11
const BDIO_BIN_INT32 = 240
const BDIO_BIN_INT64 = 241
const BDIO_BIN_F32 = 242
const BDIO_BIN_F64 = 243
const BDIO_HASH_MAGIC_S = 1515784845
user = " "
host = " "
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment