package fat-filesystem

  1. Overview
  2. Docs
Pure OCaml implementation of the FAT filesystem

Install 

dune-project
 Dependency

github.com Readme Changelog License Edit opam file Versions (5)

Authors

  1. D
    Dave Scott
  2. A
    Anil Madhavapeddy

Maintainers

  1. D
    dave@recoil.org

Sources

fat-filesystem-v0.14.0.tbz
sha256=07312d63c0b215dc1db1036db7493500fe5fe20cad05f189a74b5c51e85d8af5
sha512=856514a926d451c74756b70910f9e06aa7b55a85b5e3c1306ce4de8b3f56b477332f9f81ea85b71a591eb0cdbc540debaa2d2f418fe07aa316abb68c4d314b1c

doc/fat-filesystem/Fat_name/index.html

Module Fat_nameSource

Sourcetype datetime = {
  1. year : int;
  2. month : int;
  3. day : int;
  4. hours : int;
  5. mins : int;
  6. secs : int;
  7. ms : int;
}
Sourceval epoch : datetime
Sourcetype lfn = {
  1. lfn_deleted : bool;
  2. lfn_last : bool;
    (*

    marks the highest sequence number

    *)
  3. lfn_seq : int;
  4. lfn_checksum : int;
  5. lfn_utf16_name : string;
}

Long filename entry: the same size as an original DOS disk entry

Sourcetype dos = {
  1. filename : string;
    (*

    8 chars

    *)
  2. ext : string;
    (*

    3 chars

    *)
  3. deleted : bool;
  4. read_only : bool;
  5. hidden : bool;
  6. system : bool;
  7. volume : bool;
  8. subdir : bool;
  9. archive : bool;
  10. create : datetime;
  11. access : datetime;
  12. modify : datetime;
  13. start_cluster : int;
  14. file_size : int32;
  15. is_dot : bool;
  16. is_dotdot : bool;
}

A DOS disk entry

Sourcetype single_entry =
  1. | Dos of dos
  2. | Lfn of lfn
  3. | End
    (*

    Useful for streaming entries to/from the disk

    *)
Sourcetype r = {
  1. utf_filename : string;
  2. dos : int * dos;
  3. lfns : (int * lfn) list;
}

A high-level directory entry, complete with reconstructed UTF name and offsets of each individual entry on the disk

Sourceval fake_root_entry : r
Sourceval file_size_of : r -> int32
Sourceval deleted : r -> bool
Sourceval filename_of : r -> string
Sourceval to_single_entries : r -> single_entry list
Sourceval dos_name_of_filename : string -> string * string
Sourceval compute_checksum : dos -> int

Returns the checksum corresponding to the 8.3 DOS filename

Sourceval make : ?read_only:bool -> ?system:bool -> ?subdir:bool -> string -> r
Sourceval to_string : r -> string

to_string r returns a canonical version of the name in UTF-8

Sourceval to_pretty_string : r -> string

to_pretty_string r returns a pretty version of the filename, containing both legacy DOS, extra UTF16, size and time components.

Sourceval int_to_hms : int -> int * int * int
Sourceval hms_to_int : (int * int * int) -> int
Sourceval int_of_time : datetime -> int
Sourceval time_of_int : int -> int -> int -> datetime
Sourceval int_of_date : datetime -> int
Sourceval unmarshal : Cstruct.t -> single_entry

unmarshal slot parses a single directory entry from slot

Sourceval marshal : Cstruct.t -> single_entry -> unit

marshal slot single_entry writes single_entry into slot

Sourceval sizeof : int

the size in bytes of a single_entry

Sourceval blocks : Cstruct.t -> (int * Cstruct.t) list

blocks bits returns the directory chopped into individual bitstrings, each one containing a possible name (fragment)

Sourceval fold : ('a -> int -> r -> 'a) -> 'a -> Cstruct.t -> 'a

fold f initial bits folds f acc offset dir_entry across all the reconstructed directory entries contained in bits.

Sourceval list : Cstruct.t -> r list

list bits returns a list of valid (not deleted) directory entries contained within the directory bits

Sourceval next : Cstruct.t -> int option

next bits returns the bit offset of a free directory slot. Note this function does not recycle deleted elements.

Sourceval add : Cstruct.t -> r -> Fat_update.t list

add block t return the update required to add t to the directory block. Note the update may be beyond the end of block indicating more space needs to be allocated.

Sourceval name_match : string -> r -> bool
Sourceval find : string -> r list -> r option

find name list returns Some d where d is a name with name name (or None)

Sourceval remove : Cstruct.t -> string -> Fat_update.t list

remove buf filename erases any entries corresponding to filename from buf

Sourceval modify : Cstruct.t -> string -> int32 -> int -> Fat_update.t list

modify buf filename file_size start_cluster changes any entry corresponding to filename in buf to have file_size and start_cluster