Citation class

Constructors

Citation({int? endLine, String? file, int? line, String? repo, String? symbol})

Returns a new Citation instance.

Properties

endLine ↔ int?

EndLine is its last line, inclusive.

getter/setter pair

file ↔ String?

File is the path inside the repo, relative to its root.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

line ↔ int?

Line is the first line of the cited region, 1-based.

getter/setter pair

repo ↔ String?

Repo is the repository the cited code lives in ("owner/name"), absent when the ask was already scoped to one.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

symbol ↔ String?

Symbol is the declaration the region belongs to, when it belongs to one.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → Citation?

Returns a new Citation instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<Citation>

mapFromJson(dynamic json) → Map<String, Citation>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<Citation>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.