gleamunison/storage

Types

StorageAdapter

Trusted key/value primitives, including mutable branch pointers. Untrusted immutable content must use insert_content, not insert directly.

pub type StorageAdapter {
  StorageAdapter(
    insert: fn(identity.DefinitionRef, BitArray) -> Result(
      Nil,
      StorageError,
    ),
    lookup: fn(identity.DefinitionRef) -> Result(
      option.Option(BitArray),
      StorageError,
    ),
    delete: fn(identity.DefinitionRef) -> Result(
      Nil,
      StorageError,
    ),
    list_refs: fn() -> Result(
      List(identity.DefinitionRef),
      StorageError,
    ),
    close: fn() -> Result(Nil, StorageError),
  )
}

Constructors

StorageAdapter(
  insert: fn(identity.DefinitionRef, BitArray) -> Result(
    Nil,
    StorageError,
  ),
  lookup: fn(identity.DefinitionRef) -> Result(
    option.Option(BitArray),
    StorageError,
  ),
  delete: fn(identity.DefinitionRef) -> Result(Nil, StorageError),
  list_refs: fn() -> Result(
    List(identity.DefinitionRef),
    StorageError,
  ),
  close: fn() -> Result(Nil, StorageError),
)

Arguments

delete: Remove one binding by ref. There is no bulk wipe: retraction names what it removes, so a typo cannot empty a store.

StorageError

</>

pub type StorageError {
  StorageError(message: String)
  NotFound
  IoError(reason: String)
}

Constructors

```
StorageError(message: String)
```
```
NotFound
```
```
IoError(reason: String)
```

Values

describe_error

</>

pub fn describe_error(error: StorageError) -> String

dets

</>

pub fn dets(path: String) -> Result(StorageAdapter, StorageError)

ffi_dets_delete

</>

pub fn ffi_dets_delete(
  tab: BitArray,
  ref: BitArray,
) -> Result(Nil, StorageError)

ffi_dets_insert

</>

pub fn ffi_dets_insert(
  tab: BitArray,
  ref: BitArray,
  bytes: BitArray,
) -> Result(Nil, StorageError)

ffi_dets_list_refs

</>

pub fn ffi_dets_list_refs(
  tab: BitArray,
) -> Result(List(BitArray), StorageError)

ffi_dets_lookup

</>

pub fn ffi_dets_lookup(
  tab: BitArray,
  ref: BitArray,
) -> Result(option.Option(BitArray), StorageError)

ffi_ets_delete

</>

pub fn ffi_ets_delete(
  tab: BitArray,
  ref: BitArray,
) -> Result(Nil, StorageError)

ffi_ets_insert

</>

pub fn ffi_ets_insert(
  tab: BitArray,
  ref: BitArray,
  bytes: BitArray,
) -> Result(Nil, StorageError)

ffi_ets_list_refs

</>

pub fn ffi_ets_list_refs(
  tab: BitArray,
) -> Result(List(BitArray), StorageError)

ffi_ets_lookup

</>

pub fn ffi_ets_lookup(
  tab: BitArray,
  ref: BitArray,
) -> Result(option.Option(BitArray), StorageError)

ffi_mnesia_delete

</>

pub fn ffi_mnesia_delete(
  tab: BitArray,
  ref: BitArray,
) -> Result(Nil, StorageError)

ffi_mnesia_insert

</>

pub fn ffi_mnesia_insert(
  tab: BitArray,
  ref: BitArray,
  bytes: BitArray,
) -> Result(Nil, StorageError)

ffi_mnesia_list_refs

</>

pub fn ffi_mnesia_list_refs(
  tab: BitArray,
) -> Result(List(BitArray), StorageError)

ffi_mnesia_lookup

</>

pub fn ffi_mnesia_lookup(
  tab: BitArray,
  ref: BitArray,
) -> Result(option.Option(BitArray), StorageError)

ffi_partitioned_dets_delete

</>

pub fn ffi_partitioned_dets_delete(
  tab: BitArray,
  ref: BitArray,
) -> Result(Nil, StorageError)

ffi_partitioned_dets_insert

</>

pub fn ffi_partitioned_dets_insert(
  tab: BitArray,
  ref: BitArray,
  bytes: BitArray,
) -> Result(Nil, StorageError)

ffi_partitioned_dets_list_refs

</>

pub fn ffi_partitioned_dets_list_refs(
  tab: BitArray,
) -> Result(List(BitArray), StorageError)

ffi_partitioned_dets_lookup

</>

pub fn ffi_partitioned_dets_lookup(
  tab: BitArray,
  ref: BitArray,
) -> Result(option.Option(BitArray), StorageError)

inmemory

</>

pub fn inmemory() -> StorageAdapter

insert_content

</>

pub fn insert_content(
  adapter: StorageAdapter,
  ref: identity.DefinitionRef,
  bytes: BitArray,
) -> Result(Nil, StorageError)

Validate before write; preserve the first valid binding and report I/O errors.

mnesia

</>

pub fn mnesia(
  table_name: String,
) -> Result(StorageAdapter, StorageError)

verify_content

</>

pub fn verify_content(
  ref: identity.DefinitionRef,
  bytes: BitArray,
) -> Result(Nil, StorageError)