https://github.com/DutchGhost/zorrow

Borrowchecker in Zig
https://github.com/DutchGhost/zorrow

Last synced: 13 days ago
JSON representation

Borrowchecker in Zig

• Host: GitHub
• URL: https://github.com/DutchGhost/zorrow
• Owner: DutchGhost
• License: mit
• Created: 2020-06-08T19:08:57.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T18:36:15.000Z (over 1 year ago)
• Last Synced: 2024-02-26T20:38:09.370Z (4 months ago)
• Language: Zig
• Size: 14.6 KB
• Stars: 92
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-stars - zorrow
• awesome-zig - DutchGhost/zorrow

README

        
# Zorrow

This is a userlevel implementation of borrowchk in Zig.

This system is *not* borrowchk, as it requires to pass in unique types for operations

like acquiring a borrow, and reading from it. This library does not check for uniqueness

of the types passed in, it's up to the programmer to do this correctly.

An example of what is ment by `unique type`:

```Zig

var cell = RefCell(usize, opaque {}).init(10);

var borrow = cell.borrow(opaque {});

defer borrow.release();

var value = borrow.read(opaque {});

```

Here we see `opaque {}` three times. it is required to pass those in, as Zorrow

heavily relies on unique types passed into it's API.

## Minimum supported `Zig`

`master`

## Recent changes

  * 0.2.1

    * Change all occurrences of `var` as argument type to `anytype`.

  * 0.2

    * Allow the use of `.{}` where previously `struct {}` was required.

  * 0.1

    * Initial implementation

## Contributors

  * [suirad](https://github.com/suirad)

  * [kprotty](https://github.com/kprotty)

  * [Kassane](https://github.com/kassane)