self-reference 0.2.2

A Self-Reference Helper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# PLEASE READ THIS

This project is not product ready. I am going to polish everything when GAT is on stable.


# Self-Reference

A Self-Refernece Helper (Inspired From [Selfie](https://github.com/prokopyl/selfie))

this crate provides safe access to its self-reference.
the main idea is not initializing references when object not pinned(which is not safe and makes many self-referenial crate more complex)
providing only pinned reference makes lot more easier to design self-referential object.
on `self-reference` crate. you only can initialize reference object that has `'static` lifetime means always safe.

# Initializing Reference Object


The major difference from other self-referential crate is initializing referential object.
you only can initialize reference object that has `'static` lifetime

```rust
let mut reference: SelfReference<String, Ref<str>> = SelfReference::new(String::new(), || {
    // you can't get reference of object while initialization.
    // only possible cases are reference that has `'static` lifetime.
    ""
});
pin_mut!(reference);

// this is totally SAFE. this lowers `'static` lifetime into some other lifetime.
reference.get_ref();
```

# Reset Mechanism


The only way to initialize reference object is using `reset` method. remember!! you can use reset method when `SelfReference` object is pinned.

```rust
let mut reference: SelfReference<String, Ref<str>> = SelfReference::new("self-reference".to_string(), || "");
pin_mut!(reference);

// You can reset object to set referencial object to hold object itself.
reference.reset_unpin(|s| &s[..4]);
println!("{}", reference.get_ref()); // prints "self"
```