smart_access 0.4.1

A minimalistic zero-dependency "lazy bidirectional pointer" framework.
Documentation

Smart accessors for Rust

crate docs

Overview

There are many sorts of “smart pointers”. They have following things in common:

  • a simple protocol for accessing the data (make some bookkeeping and then give something equivalent to a raw pointer to the data)
  • some nontrivial logic of ownership management

This crate provides “smart accessors”:

  • they aren't concerned with questions of ownership
  • they give a bidirectional view of the data: updating the accessed data can cause a nontrivial change of other data linked with the data being accessed
  • the accessed view can be entirely virtual: it can be constructed only for the duration of the access

For code examples see the docs.

Usage

Simply include

smart_access = "0.4"

in your Cargo.toml.

Variants

The library, although being very small, includes some pluggable components.

For a bare-bones version use

smart_access = { version = "0.4", default-features = false }

But usually you'll want something more convenient.

Accessors for Vec, HashMap and BTreeMap

smart_access = { version = "0.4", default-features = false, features = ["std_collections"] }

A maximal no_std variant

smart_access = { version = "0.4", default-features = false, features = ["batch_ct", "detach"] }

Beware

The detach feature as currently implemented has serious limitations.

This feature is being currently reworked so try not to rely on it.

Versions

  • 0.4.1: Fixed some serious bugs in the detach-enabled version of the crate.
  • 0.4.0: Public API for using access batches as function inputs/outputs.
  • 0.3.0: Public API for using detached accessors as function inputs/outputs.
  • 0.2.2: New feature detach allows one to detach an accessor from the source of the data accessed.
  • 0.2.1: Now really works on no_std.
  • 0.2.0: Simplistic batch editing + breaking change for rt-batches + doc improvements.
  • 0.1.2: A bit more user-friendly docs.
  • 0.1.1: Only the README has been updated.
  • 0.1.0: The first iteration.