attempting

Author: AWeirdDev

docs/dumping.md

@@ -37,6 +37,10 @@ print(data)  # Money(swag=True)
 
 Exacting uses [rkyv](https://docs.rs/rkyv/latest/rkyv/) for serialization/deserialization.
 
+!!! warning "Lazy developer warning"
+    
+    This thingy is experimental. It's not yet ready for production, y'know.
+
 ```python
 from exacting import Exact
 

docs/fields.md

@@ -48,34 +48,12 @@ Hamburger(name="WHOPPER")
 Hamburger(name="bigmac")
 ```
 
-
-??? failure "TypeError: Error while validating…"
-
-    ```
-    TypeError: 
-    Error while validating dataclass 'Hamburger' at attribute 'name' (field validator):
-    Failed to validate Regex on str (doesn't match)
-    ```
-
 Note that the `regex` parameter won't work (skipped) if used on field types that aren't `str`.
 
 ## Aliases
 
 Aliases are only used when serializing/deserializing.
 
-```python
-from exacting import Exact, field
-
-class Person(Exact):
-    name: str
-    description: str = field(alias="desc")
+!!! warning
 
-# serializing
-person = Person(name="Me", description="broke af")
-data = person.exact_as_json()
-print(data)  # {"name": "Me", "desc": "broke af"}
-
-# deserializing
-person2 = Person.exact_from_json(data)
-print(person2)  # Person(name='Me', description='broke af')
-```
+    We're still working on it... stay tuned, I guess.

docs/index.md

@@ -92,7 +92,7 @@ Show(
 )
 ```
 
-??? failure "TypeError: Error while validating…"
+??? failure "ValidationError: During validation of…"
 
     ``` python
     ValidationError:

docs/internals/result.md

@@ -0,0 +1,94 @@
+# Result
+
+The `Result` class indicates the success/failure of validation.
+
+```python
+from exacting import Result
+
+# Success
+Result.Ok("some value")
+
+# Error
+Result.Err(
+    "You bad",
+    "literally"
+)
+```
+
+## Is OK?
+
+This checks if the validation result is OK.
+
+```python
+if some_result.is_ok():
+    ... # good!
+else:
+    ... # bad!
+```
+
+## Raising
+
+`Result` can help you raise a `ValidationError` if errors are present.
+
+```python
+some_result.raise_for_err()
+```
+
+## Unwrapping
+
+You can get the data that got through the validation by unwrapping, or the error messages.
+
+```python
+ok = Result.Ok(-123)
+print(ok.unwrap())  # -123
+
+err = Result.Err("be be nos")
+print(err.unwrap_err())  # deque(['be be nos'])
+```
+
+## Trace
+
+You can trace errors down using the `trace()` function, making previous errors appear indented.
+
+```python
+base_err = Result.Err("Gustavo Fring")
+
+(
+    base_err
+        .trace("Woah, there's a gustavo down here")
+        .trace("Breaking bad!")
+        .raise_for_err()
+)
+```
+
+??? failure "ValidationError: Breaking bad!"
+
+    ```
+    ValidationError: 
+    Breaking bad!
+      • Woah, there's a gustavo down here
+        • Gustavo Fring
+    ```
+
+## Trace below
+
+Make other errors appear indented below your message.
+
+```python
+error1 = Result.Err("ooga", "booga")
+error2 = Result.trace_below(
+    "Check these out:",
+    *error1.unwrap_err()
+)
+
+error2.raise_for_err()
+```
+
+??? failure "ValidationError: Check these out:"
+
+    ```
+    ValidationError: 
+    Check these out:
+      • ooga
+      • booga
+    ```

docs/internals/unsafe.md

@@ -0,0 +1,20 @@
+# Unsafe
+
+If you take a closer look at a model inherited from the `Exact` model, there's a `__unsafe_init__()` function which allows you to skip all type checks.
+
+However, if directly called, you'd get an error:
+
+```python
+from exacting import Exact
+
+class Person(Exact):
+    name: str
+
+Person.__unsafe_init__(name="Walter")
+```
+
+??? failure "RuntimeError: Scope is not in unsafe()…"
+
+    ```python
+    RuntimeError: Scope is not in unsafe(), canceled operation
+    ```