#borrow #sharing #share #borrowing #reference #data #traits

no-std borrow-or-share

Traits for either borrowing or sharing data

6 releases

0.2.2 Mar 24, 2024
0.2.1 Mar 24, 2024
0.1.0 Mar 6, 2024
0.0.1 Mar 5, 2024

#1213 in Rust patterns

Download history 23/week @ 2024-06-10 22/week @ 2024-06-17 16/week @ 2024-06-24 44/week @ 2024-07-01 66/week @ 2024-07-08 30/week @ 2024-07-15 14/week @ 2024-07-22 19/week @ 2024-07-29 33/week @ 2024-08-05 2475/week @ 2024-08-12 40/week @ 2024-08-19 320/week @ 2024-08-26 379/week @ 2024-09-02 505/week @ 2024-09-09 392/week @ 2024-09-16 1303/week @ 2024-09-23

2,605 downloads per month
Used in 11 crates (via fluent-uri)

MIT-0 license

12KB
94 lines

borrow-or-share

Traits for either borrowing or sharing data.

crates.io build license

See below for a basic usage of the crate. See the documentation for a detailed walkthrough.

Basic usage

Suppose that you have a generic type that either owns some data or holds a reference to them. You can use this crate to implement on this type a method taking &self that either borrows from *self or from behind a reference it holds:

use borrow_or_share::BorrowOrShare;

struct Text<T>(T);

impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Text<T> {
    fn as_str(&'i self) -> &'o str {
        self.0.borrow_or_share()
    }
}

// The returned reference is borrowed from `*text`
// and lives as long as `text`.
fn borrow(text: &Text<String>) -> &str {
    text.as_str()
}

// The returned reference is borrowed from `*text.0`, lives
// longer than `text` and is said to be shared with `*text`.
fn share<'a>(t: &Text<&'a str>) -> &'a str {
    text.as_str()
}

Credit

Credit goes to @beepster4096 for figuring out a safe version of the code.

No runtime deps

Features