Struct GraphTraversalOptions 

pub struct GraphTraversalOptions {
    pub fan_out_soft: u16,
    pub fan_out_hard: u16,
    pub fan_out_partial: bool,
    pub max_visited: usize,
}

Per-query graph traversal configuration.

Controls fan-out limits, partial result handling, and visited node caps for scatter-gather graph queries across shards.

Fields

fan_out_soft: u16

Soft warning threshold (shards per hop).

When the number of shards reached in a single hop exceeds this value, a fan-out warning is emitted but execution continues. Default: 12

fan_out_hard: u16

Hard limit (shards per hop).

Maximum number of shards that can be queried in a single hop. If exceeded and fan_out_partial is false, returns FAN_OUT_EXCEEDED error. Default: 16

fan_out_partial: bool

If true, return partial results instead of FAN_OUT_EXCEEDED error.

When the hard limit is exceeded, instead of failing with FAN_OUT_EXCEEDED, this flag allows the response to be marked as truncated with partial results. Default: false

max_visited: usize

Cap on total visited nodes across all shards.

Once this limit is reached, no further node exploration occurs. Default: 100_000

Implementations

impl GraphTraversalOptions

pub fn new() -> Self

Create a new GraphTraversalOptions with default values.

Trait Implementations

impl Clone for GraphTraversalOptions

fn clone(&self) -> GraphTraversalOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphTraversalOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GraphTraversalOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphTraversalOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GraphTraversalOptions

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for GraphTraversalOptions

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for GraphTraversalOptions

fn eq(&self, other: &GraphTraversalOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GraphTraversalOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GraphTraversalOptions

impl ToMessagePack for GraphTraversalOptions

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.