eyecite 0.0.0

An unoffical port of the freelawproject's eyecite.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use crate::tokenizers::models::Token;
use std::collections::{HashMap, HashSet};

#[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Hash, Clone)]
pub enum CitationMetadata<'a> {
    Parenthetical(&'a str),
    PinCite(&'a str),
    Year(&'a str),
    Court(&'a str),
    Plaintiff(&'a str),
    Defendant(&'a str),
    Extra(&'a str),
    AntecedentGuess(&'a str),
    Volume(&'a str),
}

pub struct CitationSource<'a> {
    pub token: Token<'a>,
    pub index: usize,
    pub span_start: Option<usize>,
    pub span_end: Option<usize>,
    pub groups: HashMap<String, String>,
    pub metadata: HashSet<CitationMetadata<'a>>,
}

pub enum Citation<'a> {
    Resource {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
    },
    Law {
        source: CitationSource<'a>,
        publisher: Option<&'a str>,
        day: Option<&'a str>,
        month: Option<&'a str>,
    },
    Journal {
        source: CitationSource<'a>,
    },
    Case {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
        court: Option<&'a str>,
    },
    /**
    Convenience class which represents a standard, fully named citation,
    i.e., the kind of citation that marks the first time a document is cited.

    Example:
    ```text
    Adarand Constructors, Inc. v. Peña, 515 U.S. 200, 240
    ```
    **/
    FullCase {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
        court: Option<&'a str>,
        plaintiff: Option<&'a str>,
        defendant: Option<&'a str>,
        extra: Option<&'a str>,
    },
    /**
    Convenience class which represents a short form citation, i.e., the kind
    of citation made after a full citation has already appeared. This kind of
    citation lacks a full case name and usually has a different page number
    than the canonical citation.

    Examples:
    ```text
    Adarand, 515 U.S., at 241
    Adarand, 515 U.S. at 241
    515 U.S., at 241
    ```
    **/
    ShortCase {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
        court: Option<&'a str>,
        antecedent_guess: Option<&'a str>,
    },
    /**
    Convenience class which represents a 'supra' citation, i.e., a citation
    to something that is above in the document. Like a short form citation,
    this kind of citation lacks a full case name and usually has a different
    page number than the canonical citation.


    Examples:
    ```text
    Adarand, supra, at 240
    Adarand, 515 supra, at 240
    Adarand, supra, somethingelse
    Adarand, supra. somethingelse
    ```
     **/
    Supra {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
        court: Option<&'a str>,
        antecedent_guess: Option<&'a str>,
        volume: Option<&'a str>,
    },
    /**
    Convenience class which represents an 'id' or 'ibid' citation, i.e., a
    citation to the document referenced immediately prior. An 'id' citation is
    unlike a regular citation object since it has no knowledge of its reporter,
    volume, or page. Instead, the only helpful information that this reference
    possesses is a record of the pin cite after the 'id' token.

    Example: `"... foo bar," id., at 240`
    **/
    Id {
        source: CitationSource<'a>,
        pin_cite: Option<&'a str>,
        year: Option<&'a str>,
        court: Option<&'a str>,
        antecedent_guess: Option<&'a str>,
        volume: Option<&'a str>,
    },
    /**
    Convenience class which represents an unknown citation. A recognized
    citation should theoretically be parsed as a CaseCitation, FullLawCitation,
    or a FullJournalCitation. If it's something else, this class serves as
    a naive catch-all.
    **/
    Unknown {
        source: CitationSource<'a>,
    },
}