licence_audit/exception

Types

Coverage

pub type Coverage {
  NotEvaluated(String)
  Evaluated(
    matched: List(Int),
    unavailable: List(#(String, String)),
  )
}

Constructors

```
NotEvaluated(String)
```

Evaluated(
  matched: List(Int),
  unavailable: List(#(String, String)),
)

Decision

</>

pub type Decision {
  Unaccepted
  Excepted(Exception)
  Expired(Exception)
}

Constructors

```
Unaccepted
```
```
Excepted(Exception)
```
```
Expired(Exception)
```

Error

</>

pub type Error {
  UnknownField(String)
  NestedFields
  RequiredString(String)
  UnexpectedField(String)
  InvalidFinding
  LicenceRequiresHex
  InvalidExpiryType
  InvalidPurl
  InvalidDate
  OverlappingEntries(first: Exception, second: Exception)
  AmbiguousIdentity(Exception)
}

Constructors

```
UnknownField(String)
```
```
NestedFields
```
```
RequiredString(String)
```
```
UnexpectedField(String)
```
```
InvalidFinding
```
```
LicenceRequiresHex
```
```
InvalidExpiryType
```
```
InvalidPurl
```
```
InvalidDate
```

OverlappingEntries(first: Exception, second: Exception)

```
AmbiguousIdentity(Exception)
```

Exception

</>

pub type Exception {
  Exception(
    number: Int,
    purl: String,
    finding: Finding,
    reason: String,
    expires: option.Option(String),
  )
}

Constructors

Exception(
  number: Int,
  purl: String,
  finding: Finding,
  reason: String,
  expires: option.Option(String),
)

Finding

</>

pub type Finding {
  DeniedLicence(String)
  UnallowedLicence(String)
  InvalidLicenceExpression(String)
  NoLicencesDeclared
  Advisory(String)
}

Constructors

```
DeniedLicence(String)
```
```
UnallowedLicence(String)
```
```
InvalidLicenceExpression(String)
```
```
NoLicencesDeclared
```
```
Advisory(String)
```

Values

accepted

</>

pub fn accepted(decision: Decision) -> Bool

decide

</>

pub fn decide(
  entries: List(Exception),
  purl: String,
  finding: Finding,
  aliases: List(String),
  today: String,
) -> Result(Decision, Error)

decision_text

</>

pub fn decision_text(decision: Decision) -> String

describe_error

</>

pub fn describe_error(error: Error) -> String

finding_text

</>

pub fn finding_text(finding: Finding) -> String

is_expired

</>

pub fn is_expired(entry: Exception, today: String) -> Bool

matched

</>

pub fn matched(decisions: List(Decision)) -> List(Int)

parse

</>

pub fn parse(
  table: List(#(List(String), tomlet.Value)),
  number: Int,
) -> Result(Exception, Error)

summary

</>

pub fn summary(
  entries: List(Exception),
  today: String,
  licences: Coverage,
  advisories: Coverage,
) -> String

utc_date

</>

pub fn utc_date(now: timestamp.Timestamp) -> String

validate_date

</>

pub fn validate_date(date: String) -> Result(Nil, Error)

validate_identities

</>

pub fn validate_identities(
  entries: List(Exception),
  purls: List(String),
) -> Result(Nil, Error)

validate_unique

</>

pub fn validate_unique(
  entries: List(Exception),
) -> Result(Nil, Error)