sipha-core 0.3.0

Core foundation types and traits for sipha - minimal dependencies, no parsing logic
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# sipha-core

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Repository](https://img.shields.io/badge/github-sipha-blue)](https://github.com/NyalephTheCat/sipha)
[![Crates.io](https://img.shields.io/crates/v/sipha-core)](https://crates.io/crates/sipha-core)
[![docs.rs](https://docs.rs/sipha-core/badge.svg)](https://docs.rs/sipha-core)

Core foundation types and traits for sipha - minimal dependencies, no parsing logic.

## Overview

`sipha-core` is the minimal foundation of the sipha parser ecosystem. It provides only the essential traits and types that are shared across all other `sipha` crates:

- **Core traits**: `TokenKind`, `RuleId`, `NodeId`, `SymbolId`, `GrammarContext`, `AstNode`
- **Basic types**: `Span`, `Token`, `TokenTrivia`

This crate has minimal dependencies and contains no parsing logic, focusing solely on defining the interfaces for tokens, rules, nodes, and spans.

## Quick Start

Add `sipha-core` to your `Cargo.toml`:

```toml
[dependencies]
sipha-core = "0.1.1"
```

With optional features:

```toml
[dependencies]
sipha-core = { version = "0.1.1", features = ["serde"] }
```

## Features

- `default`: No features enabled (minimal dependencies)
- `serde`: Enables serialization/deserialization for `Span` and `Token`

## Example

```rust
use sipha_core::traits::{TokenKind, RuleId, NodeId};
use sipha_core::span::Span;
use sipha_core::token::Token;

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum MyToken {
    Ident,
    Number,
}

impl TokenKind for MyToken {
    fn is_trivia(&self) -> bool {
        false
    }
}

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum MyRule {
    Expression,
    Term,
}

impl RuleId for MyRule {}

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct MyNodeId(usize);

impl NodeId for MyNodeId {
    fn from_raw(raw: usize) -> Self {
        MyNodeId(raw)
    }
    fn to_raw(self) -> usize {
        self.0
    }
}
```

## Documentation

For more information, see:
- [Architecture Guide](https://github.com/NyalephTheCat/sipha/blob/release/docs/concepts/architecture.md)
- [Main README](https://github.com/NyalephTheCat/sipha/blob/release/README.md)

## License

This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.

## See Also

- [sipha](https://crates.io/crates/sipha) - Umbrella crate with feature flags
- [sipha-tree](../sipha-tree) - CST/AST construction
- [sipha-parse](../sipha-parse) - Parsing engine
- [sipha-error](../sipha-error) - Error handling