Crate nuts_directory

Source
Expand description

Nuts backend implementation where the blocks of the container are stored in a file hierarchy.

§Introduction

The nuts-directory crate implements a nuts backend where the blocks of the container are stored in a file hierarchy. Each block is identified by an id, which is basically a 16 byte random number.

When storing a block to disks the path to the file is derived from the id:

  1. The id is converted into a hex string.
  2. The path then would be: <first two chars>/<next two chars>/<remaining chars>

The header of the container is stored in the file 00/00/0000000000000000000000000000.

§Create a new backend instance

The CreateOptions type is used to create a new backend instance, which is passed to the Container::create method. You need at least a directory where the backend put its blocks. See the CreateOptions documentation for further options.

§Open an existing backend

The OpenOptions type is used to open a backend instance, which is passed to the Container::open method. You need the directory where the backend put its blocks.

Structs§

CreateOptions
Options needed to create the backend.
DirectoryBackend
Id
The id of the backend.
Info
Information from the backend.
OpenOptions
Options needed to open the backend.
Settings
Settings used by the backend.

Enums§

Error
The error type for the directory backend.