GraphNeighborsOut class

Constructors

GraphNeighborsOut({int? bound, int? depth, List<String> entities = const [], bool? truncated})

Returns a new GraphNeighborsOut instance.

Properties

bound ↔ int?

Bound is the ceiling this walk was held to, the same for every caller, so Truncated can be read against a number rather than guessed at.

getter/setter pair

depth ↔ int?

Depth is the deepest hop count actually reached. It is at most the depth asked for, and smaller when the walk ran out of edges first.

getter/setter pair

entities ↔ List<String>

Entities is everything reached, the seeds included, ordered by the fewest hops that reach each one and then by key.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

truncated ↔ bool?

Truncated says the bound stopped the walk. The bound is part of the answer rather than a silent short read.

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) → GraphNeighborsOut?

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

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

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

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

Constants

requiredKeys → const Set<String>

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